2 Unix SMB/CIFS implementation.
3 Samba utility functions
4 Copyright (C) Jelmer Vernooij 2002-2003,2005-2007
5 Copyright (C) Stefan (metze) Metzmacher 2003
6 Copyright (C) Andrew Bartlett 2011
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "dynconfig/dynconfig.h"
24 #include "lib/util/internal_module.h"
25 #include "system/filesys.h"
26 #include "system/dir.h"
29 * Obtain the init function from a shared library file
31 samba_module_init_fn load_module(const char *path, bool is_probe, void **handle_out)
37 #if _SAMBA_BUILD_ == 3
38 /* Always try to use LAZY symbol resolving; if the plugin has
39 * backwards compatibility, there might be symbols in the
40 * plugin referencing to old (removed) functions
42 handle = dlopen(path, RTLD_LAZY);
44 /* This should be a WAF build, where modules should be built
45 * with no undefined symbols and are already linked against
46 * the libraries that they are loaded by */
47 handle = dlopen(path, RTLD_NOW);
50 /* This call should reset any possible non-fatal errors that
51 occured since last call to dl* functions */
55 int level = is_probe ? 5 : 0;
56 DEBUG(level, ("Error loading module '%s': %s\n", path, error ? error : ""));
60 init_fn = (samba_module_init_fn)dlsym(handle, SAMBA_INIT_MODULE);
62 /* we could check dlerror() to determine if it worked, because
63 dlsym() can validly return NULL, but what would we do with
64 a NULL pointer as a module init function? */
66 if (init_fn == NULL) {
67 DEBUG(0, ("Unable to find %s() in %s: %s\n",
68 SAMBA_INIT_MODULE, path, dlerror()));
69 DEBUG(1, ("Loading module '%s' failed\n", path));
78 return (samba_module_init_fn)init_fn;
82 * Obtain list of init functions from the modules in the specified
85 samba_module_init_fn *load_modules(TALLOC_CTX *mem_ctx, const char *path)
91 samba_module_init_fn *ret = talloc_array(mem_ctx, samba_module_init_fn, 2);
101 while((entry = readdir(dir))) {
102 if (ISDOT(entry->d_name) || ISDOTDOT(entry->d_name))
105 filename = talloc_asprintf(mem_ctx, "%s/%s", path, entry->d_name);
107 ret[success] = load_module(filename, true, NULL);
109 ret = talloc_realloc(mem_ctx, ret, samba_module_init_fn, success+2);
114 talloc_free(filename);
122 /* Load a dynamic module. Only log a level 0 error if we are not checking
123 for the existence of a module (probling). */
125 static NTSTATUS do_smb_load_module(const char *module_name, bool is_probe)
128 samba_module_init_fn init;
131 init = load_module(module_name, is_probe, &handle);
133 return NT_STATUS_UNSUCCESSFUL;
136 DEBUG(2, ("Module '%s' loaded\n", module_name));
139 if (!NT_STATUS_IS_OK(status)) {
140 DEBUG(0, ("Module '%s' initialization failed: %s\n",
141 module_name, get_friendly_nt_error_msg(status)));
148 /* Load all modules in list and return number of
149 * modules that has been successfully loaded */
150 int smb_load_modules(const char **modules)
155 for(i = 0; modules[i]; i++){
156 if(NT_STATUS_IS_OK(do_smb_load_module(modules[i], false))) {
161 DEBUG(2, ("%d modules successfully loaded\n", success));
166 NTSTATUS smb_probe_module(const char *subsystem, const char *module)
168 char *full_path = NULL;
169 TALLOC_CTX *ctx = talloc_stackframe();
172 /* Check for absolute path */
174 /* if we make any 'samba multibyte string'
176 for loading string modules */
178 DEBUG(5, ("Probing module '%s'\n", module));
180 if (module[0] == '/') {
181 status = do_smb_load_module(module, true);
186 full_path = talloc_asprintf(ctx,
188 modules_path(ctx, subsystem),
193 return NT_STATUS_NO_MEMORY;
196 DEBUG(5, ("Probing module '%s': Trying to load from %s\n",
199 status = do_smb_load_module(full_path, true);