2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2009 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
11 * A copy of this license is available in the file LICENSE in the
12 * top-level directory of the distribution or, alternatively, at
13 * <http://www.OpenLDAP.org/license.html>.
24 typedef int (*MODULE_INIT_FN)(
27 typedef int (*MODULE_LOAD_FN)(
29 const char *filename);
30 typedef int (*MODULE_TERM_FN)(void);
33 struct module_regtable_t {
36 } module_regtable[] = {
37 { "null", load_null_module },
38 #ifdef SLAPD_EXTERNAL_EXTENSIONS
39 { "extension", load_extop_module },
44 typedef struct module_loaded_t {
45 struct module_loaded_t *next;
50 module_loaded_t *module_list = NULL;
52 static int module_int_unload (module_loaded_t *module);
55 static char ebuf[BUFSIZ];
58 int module_init (void)
61 const char *error = lt_dlerror();
63 strcpy( ebuf, error );
67 Debug(LDAP_DEBUG_ANY, "lt_dlinit failed: %s\n", error, 0, 0);
72 return module_path( LDAP_MODULEDIR );
75 int module_kill (void)
77 /* unload all modules before shutdown */
78 while (module_list != NULL) {
79 module_int_unload(module_list);
83 const char *error = lt_dlerror();
85 strcpy( ebuf, error );
89 Debug(LDAP_DEBUG_ANY, "lt_dlexit failed: %s\n", error, 0, 0);
96 void * module_handle( const char *file_name )
98 module_loaded_t *module;
100 for ( module = module_list; module; module= module->next ) {
101 if ( !strcmp( module->name, file_name )) {
108 int module_unload( const char *file_name )
110 module_loaded_t *module;
112 module = module_handle( file_name );
114 module_int_unload( module );
117 return -1; /* not found */
120 int module_load(const char* file_name, int argc, char *argv[])
122 module_loaded_t *module;
125 MODULE_INIT_FN initialize;
129 #define file file_name
132 /* silently ignore attempts to load a module that's already present */
133 module = module_handle( file_name );
137 module = (module_loaded_t *)ch_calloc(1, sizeof(module_loaded_t) +
139 if (module == NULL) {
140 Debug(LDAP_DEBUG_ANY, "module_load failed: (%s) out of memory\n", file_name,
145 strcpy( module->name, file_name );
148 strcpy( file, file_name );
152 * The result of lt_dlerror(), when called, must be cached prior
153 * to calling Debug. This is because Debug is a macro that expands
154 * into multiple function calls.
156 if ((module->lib = lt_dlopenext(file)) == NULL) {
157 error = lt_dlerror();
159 strcpy( ebuf, error );
163 Debug(LDAP_DEBUG_ANY, "lt_dlopenext failed: (%s) %s\n", file_name,
170 Debug(LDAP_DEBUG_CONFIG, "loaded module %s\n", file_name, 0, 0);
174 #pragma convlit(suspend)
176 if ((initialize = lt_dlsym(module->lib, "init_module")) == NULL) {
178 #pragma convlit(resume)
180 Debug(LDAP_DEBUG_CONFIG, "module %s: no init_module() function found\n",
183 lt_dlclose(module->lib);
188 /* The imported init_module() routine passes back the type of
189 * module (i.e., which part of slapd it should be hooked into)
190 * or -1 for error. If it passes back 0, then you get the
191 * old behavior (i.e., the library is loaded and not hooked
194 * It might be better if the conf file could specify the type
195 * of module. That way, a single module could support multiple
196 * type of hooks. This could be done by using something like:
198 * moduleload extension /usr/local/openldap/whatever.so
200 * then we'd search through module_regtable for a matching
201 * module type, and hook in there.
203 rc = initialize(argc, argv);
205 Debug(LDAP_DEBUG_CONFIG, "module %s: init_module() failed\n",
208 lt_dlclose(module->lib);
213 if (rc >= (int)(sizeof(module_regtable) / sizeof(struct module_regtable_t))
214 || module_regtable[rc].proc == NULL)
216 Debug(LDAP_DEBUG_CONFIG, "module %s: unknown registration type (%d)\n",
219 module_int_unload(module);
223 rc = (module_regtable[rc].proc)(module, file_name);
225 Debug(LDAP_DEBUG_CONFIG, "module %s: %s module could not be registered\n",
226 file_name, module_regtable[rc].type, 0);
228 module_int_unload(module);
232 module->next = module_list;
233 module_list = module;
235 Debug(LDAP_DEBUG_CONFIG, "module %s: %s module registered\n",
236 file_name, module_regtable[rc].type, 0);
241 int module_path(const char *path)
248 return lt_dlsetsearchpath( path );
251 void *module_resolve (const void *module, const char *name)
258 if (module == NULL || name == NULL)
260 return(lt_dlsym(((module_loaded_t *)module)->lib, name));
263 static int module_int_unload (module_loaded_t *module)
265 module_loaded_t *mod;
266 MODULE_TERM_FN terminate;
268 if (module != NULL) {
269 /* remove module from tracking list */
270 if (module_list == module) {
271 module_list = module->next;
273 for (mod = module_list; mod; mod = mod->next) {
274 if (mod->next == module) {
275 mod->next = module->next;
281 /* call module's terminate routine, if present */
283 #pragma convlit(suspend)
285 if ((terminate = lt_dlsym(module->lib, "term_module"))) {
287 #pragma convlit(resume)
292 /* close the library and free the memory */
293 lt_dlclose(module->lib);
299 int load_null_module (const void *module, const char *file_name)
304 #ifdef SLAPD_EXTERNAL_EXTENSIONS
308 const char *file_name
311 SLAP_EXTOP_MAIN_FN *ext_main;
312 SLAP_EXTOP_GETOID_FN *ext_getoid;
316 ext_main = (SLAP_EXTOP_MAIN_FN *)module_resolve(module, "ext_main");
317 if (ext_main == NULL) {
321 ext_getoid = module_resolve(module, "ext_getoid");
322 if (ext_getoid == NULL) {
326 rc = (ext_getoid)(0, &oid, 256);
330 if (oid.bv_val == NULL || oid.bv_len == 0) {
334 /* FIXME: this is broken, and no longer needed,
335 * as a module can call load_extop() itself... */
336 rc = load_extop( &oid, ext_main );
339 #endif /* SLAPD_EXTERNAL_EXTENSIONS */
340 #endif /* SLAPD_MODULES */