2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2007 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);
74 int module_kill (void)
76 /* unload all modules before shutdown */
77 while (module_list != NULL) {
78 module_int_unload(module_list);
82 const char *error = lt_dlerror();
84 strcpy( ebuf, error );
88 Debug(LDAP_DEBUG_ANY, "lt_dlexit failed: %s\n", error, 0, 0);
95 void * module_handle( const char *file_name )
97 module_loaded_t *module;
99 for ( module = module_list; module; module= module->next ) {
100 if ( !strcmp( module->name, file_name )) {
107 int module_unload( const char *file_name )
109 module_loaded_t *module;
111 module = module_handle( file_name );
113 module_int_unload( module );
116 return -1; /* not found */
119 int module_load(const char* file_name, int argc, char *argv[])
121 module_loaded_t *module = NULL;
124 MODULE_INIT_FN initialize;
128 #define file file_name
131 module = (module_loaded_t *)ch_calloc(1, sizeof(module_loaded_t) +
133 if (module == NULL) {
134 Debug(LDAP_DEBUG_ANY, "module_load failed: (%s) out of memory\n", file_name,
139 strcpy( module->name, file_name );
142 strcpy( file, file_name );
146 * The result of lt_dlerror(), when called, must be cached prior
147 * to calling Debug. This is because Debug is a macro that expands
148 * into multiple function calls.
150 if ((module->lib = lt_dlopenext(file)) == NULL) {
151 error = lt_dlerror();
153 strcpy( ebuf, error );
157 Debug(LDAP_DEBUG_ANY, "lt_dlopenext failed: (%s) %s\n", file_name,
164 Debug(LDAP_DEBUG_CONFIG, "loaded module %s\n", file_name, 0, 0);
168 #pragma convlit(suspend)
170 if ((initialize = lt_dlsym(module->lib, "init_module")) == NULL) {
172 #pragma convlit(resume)
174 Debug(LDAP_DEBUG_CONFIG, "module %s: no init_module() function found\n",
177 lt_dlclose(module->lib);
182 /* The imported init_module() routine passes back the type of
183 * module (i.e., which part of slapd it should be hooked into)
184 * or -1 for error. If it passes back 0, then you get the
185 * old behavior (i.e., the library is loaded and not hooked
188 * It might be better if the conf file could specify the type
189 * of module. That way, a single module could support multiple
190 * type of hooks. This could be done by using something like:
192 * moduleload extension /usr/local/openldap/whatever.so
194 * then we'd search through module_regtable for a matching
195 * module type, and hook in there.
197 rc = initialize(argc, argv);
199 Debug(LDAP_DEBUG_CONFIG, "module %s: init_module() failed\n",
202 lt_dlclose(module->lib);
207 if (rc >= (int)(sizeof(module_regtable) / sizeof(struct module_regtable_t))
208 || module_regtable[rc].proc == NULL)
210 Debug(LDAP_DEBUG_CONFIG, "module %s: unknown registration type (%d)\n",
213 module_int_unload(module);
217 rc = (module_regtable[rc].proc)(module, file_name);
219 Debug(LDAP_DEBUG_CONFIG, "module %s: %s module could not be registered\n",
220 file_name, module_regtable[rc].type, 0);
222 module_int_unload(module);
226 module->next = module_list;
227 module_list = module;
229 Debug(LDAP_DEBUG_CONFIG, "module %s: %s module registered\n",
230 file_name, module_regtable[rc].type, 0);
235 int module_path(const char *path)
242 return lt_dlsetsearchpath( path );
245 void *module_resolve (const void *module, const char *name)
252 if (module == NULL || name == NULL)
254 return(lt_dlsym(((module_loaded_t *)module)->lib, name));
257 static int module_int_unload (module_loaded_t *module)
259 module_loaded_t *mod;
260 MODULE_TERM_FN terminate;
262 if (module != NULL) {
263 /* remove module from tracking list */
264 if (module_list == module) {
265 module_list = module->next;
267 for (mod = module_list; mod; mod = mod->next) {
268 if (mod->next == module) {
269 mod->next = module->next;
275 /* call module's terminate routine, if present */
277 #pragma convlit(suspend)
279 if ((terminate = lt_dlsym(module->lib, "term_module"))) {
281 #pragma convlit(resume)
286 /* close the library and free the memory */
287 lt_dlclose(module->lib);
293 int load_null_module (const void *module, const char *file_name)
298 #ifdef SLAPD_EXTERNAL_EXTENSIONS
302 const char *file_name
305 SLAP_EXTOP_MAIN_FN *ext_main;
306 SLAP_EXTOP_GETOID_FN *ext_getoid;
310 ext_main = (SLAP_EXTOP_MAIN_FN *)module_resolve(module, "ext_main");
311 if (ext_main == NULL) {
315 ext_getoid = module_resolve(module, "ext_getoid");
316 if (ext_getoid == NULL) {
320 rc = (ext_getoid)(0, &oid, 256);
324 if (oid.bv_val == NULL || oid.bv_len == 0) {
328 /* FIXME: this is broken, and no longer needed,
329 * as a module can call load_extop() itself... */
330 rc = load_extop( &oid, ext_main );
333 #endif /* SLAPD_EXTERNAL_EXTENSIONS */
334 #endif /* SLAPD_MODULES */