2 * ircd-ratbox: A slightly useful ircd.
3 * modules.c: A module loader.
5 * Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
6 * Copyright (C) 1996-2002 Hybrid Development Team
7 * Copyright (C) 2002-2005 ircd-ratbox development team
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
32 #include "s_newconf.h"
35 #include "ircd_defs.h"
38 #include "capability.h"
43 # error "Charybdis requires loadable module support."
46 rb_dlink_list module_list
;
47 rb_dlink_list mod_paths
;
49 static const char *core_module_table
[] = {
67 #define MOD_WARN_DELTA (90 * 86400) /* time in seconds, 86400 seconds in a day */
74 ilog(L_MAIN
, "lt_dlinit failed");
78 /* Add the default paths we look in to the module system --nenolod */
79 mod_add_path(ircd_paths
[IRCD_PATH_MODULES
]);
80 mod_add_path(ircd_paths
[IRCD_PATH_AUTOLOAD_MODULES
]);
87 * side effects - returns a module path from path
90 mod_find_path(const char *path
)
95 RB_DLINK_FOREACH(ptr
, mod_paths
.head
)
99 if(!strcmp(path
, mpath
))
110 * side effects - adds path to list
113 mod_add_path(const char *path
)
117 if(mod_find_path(path
))
120 pathst
= rb_strdup(path
);
121 rb_dlinkAddAlloc(pathst
, &mod_paths
);
128 * side effects - clear the lists of paths
131 mod_clear_paths(void)
133 rb_dlink_node
*ptr
, *next_ptr
;
135 RB_DLINK_FOREACH_SAFE(ptr
, next_ptr
, mod_paths
.head
)
138 rb_free_rb_dlink_node(ptr
);
141 mod_paths
.head
= mod_paths
.tail
= NULL
;
142 mod_paths
.length
= 0;
147 * input - module to load
148 * output - index of module on success, -1 on failure
149 * side effects - none
152 findmodule_byname(const char *name
)
155 char name_ext
[PATH_MAX
+ 1];
157 rb_strlcpy(name_ext
, name
, sizeof name_ext
);
158 rb_strlcat(name_ext
, LT_MODULE_EXT
, sizeof name_ext
);
160 RB_DLINK_FOREACH(ptr
, module_list
.head
)
162 struct module *mod
= ptr
->data
;
164 if(!irccmp(mod
->name
, name
))
167 if(!irccmp(mod
->name
, name_ext
))
174 /* load_all_modules()
181 load_all_modules(bool warn
)
183 DIR *system_module_dir
= NULL
;
184 struct dirent
*ldirent
= NULL
;
185 char module_fq_name
[PATH_MAX
+ 1];
186 size_t module_ext_len
= strlen(LT_MODULE_EXT
);
188 system_module_dir
= opendir(ircd_paths
[IRCD_PATH_AUTOLOAD_MODULES
]);
190 if(system_module_dir
== NULL
)
192 ilog(L_MAIN
, "Could not load modules from %s: %s", ircd_paths
[IRCD_PATH_AUTOLOAD_MODULES
], strerror(errno
));
196 while ((ldirent
= readdir(system_module_dir
)) != NULL
)
198 size_t len
= strlen(ldirent
->d_name
);
200 if(len
> module_ext_len
&&
201 rb_strncasecmp(ldirent
->d_name
+ (len
- module_ext_len
), LT_MODULE_EXT
, module_ext_len
) == 0)
203 (void) snprintf(module_fq_name
, sizeof(module_fq_name
), "%s%c%s",
204 ircd_paths
[IRCD_PATH_AUTOLOAD_MODULES
], RB_PATH_SEPARATOR
, ldirent
->d_name
);
205 (void) load_a_module(module_fq_name
, warn
, MAPI_ORIGIN_CORE
, false);
209 (void) closedir(system_module_dir
);
212 /* load_core_modules()
216 * side effects - core modules are loaded, if any fail, kill ircd
219 load_core_modules(bool warn
)
221 char module_name
[PATH_MAX
];
225 for (i
= 0; core_module_table
[i
]; i
++)
227 snprintf(module_name
, sizeof(module_name
), "%s%c%s", ircd_paths
[IRCD_PATH_MODULES
], RB_PATH_SEPARATOR
,
228 core_module_table
[i
]);
230 if(load_a_module(module_name
, warn
, MAPI_ORIGIN_CORE
, true) == false)
233 "Error loading core module %s: terminating ircd",
234 core_module_table
[i
]);
247 load_one_module(const char *path
, int origin
, bool coremodule
)
249 char modpath
[PATH_MAX
];
250 rb_dlink_node
*pathst
;
252 if (server_state_foreground
)
253 inotice("loading module %s ...", path
);
256 origin
= MAPI_ORIGIN_CORE
;
258 RB_DLINK_FOREACH(pathst
, mod_paths
.head
)
261 const char *mpath
= pathst
->data
;
263 snprintf(modpath
, sizeof(modpath
), "%s%c%s%s", mpath
, RB_PATH_SEPARATOR
, path
, LT_MODULE_EXT
);
264 if((strstr(modpath
, "../") == NULL
) && (strstr(modpath
, "/..") == NULL
))
266 if(stat(modpath
, &statbuf
) == 0 && S_ISREG(statbuf
.st_mode
))
268 /* Regular files only please */
269 return load_a_module(modpath
, true, origin
, coremodule
);
275 sendto_realops_snomask(SNO_GENERAL
, L_ALL
, "Cannot locate module %s", path
);
279 static char unknown_ver
[] = "<unknown>";
280 static char unknown_description
[] = "<none>";
282 /* unload_one_module()
284 * inputs - name of module to unload
285 * - true to say modules unloaded, false to not
286 * output - true if successful, false if error
287 * side effects - module is unloaded
290 unload_one_module(const char *name
, bool warn
)
294 if((mod
= findmodule_byname(name
)) == NULL
)
298 ** XXX - The type system in C does not allow direct conversion between
299 ** data and function pointers, but as it happens, most C compilers will
300 ** safely do this, however it is a theoretical overlow to cast as we
301 ** must do here. I have library functions to take care of this, but
302 ** despite being more "correct" for the C language, this is more
303 ** practical. Removing the abuse of the ability to cast ANY pointer
304 ** to and from an integer value here will break some compilers.
307 /* Left the comment in but the code isn't here any more -larne */
308 switch (mod
->mapi_version
)
312 struct mapi_mheader_av1
*mheader
= mod
->mapi_header
;
313 if(mheader
->mapi_command_list
)
316 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
320 /* hook events are never removed, we simply lose the
321 * ability to call them --fl
323 if(mheader
->mapi_hfn_list
)
325 mapi_hfn_list_av1
*m
;
326 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
327 remove_hook(m
->hapi_name
, m
->fn
);
330 if(mheader
->mapi_unregister
)
331 mheader
->mapi_unregister();
336 struct mapi_mheader_av2
*mheader
= mod
->mapi_header
;
338 /* XXX duplicate code :( */
339 if(mheader
->mapi_command_list
)
342 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
346 /* hook events are never removed, we simply lose the
347 * ability to call them --fl
349 if(mheader
->mapi_hfn_list
)
351 mapi_hfn_list_av1
*m
;
352 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
353 remove_hook(m
->hapi_name
, m
->fn
);
356 if(mheader
->mapi_unregister
)
357 mheader
->mapi_unregister();
359 if(mheader
->mapi_cap_list
)
361 mapi_cap_list_av2
*m
;
362 for (m
= mheader
->mapi_cap_list
; m
->cap_name
; ++m
)
364 struct CapabilityIndex
*idx
;
366 switch (m
->cap_index
)
368 case MAPI_CAP_CLIENT
:
371 case MAPI_CAP_SERVER
:
375 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
376 "Unknown/unsupported CAP index found of type %d on capability %s when unloading %s",
377 m
->cap_index
, m
->cap_name
, mod
->name
);
379 "Unknown/unsupported CAP index found of type %d on capability %s when unloading %s",
380 m
->cap_index
, m
->cap_name
, mod
->name
);
384 if (m
->cap_id
!= NULL
)
386 capability_orphan(idx
, m
->cap_name
);
387 sendto_local_clients_with_capability(CLICAP_CAP_NOTIFY
, ":%s CAP * DEL :%s", me
.name
, m
->cap_name
);
394 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
395 "Unknown/unsupported MAPI version %d when unloading %s!",
396 mod
->mapi_version
, mod
->name
);
397 ilog(L_MAIN
, "Unknown/unsupported MAPI version %d when unloading %s!",
398 mod
->mapi_version
, mod
->name
);
402 lt_dlclose(mod
->address
);
404 rb_dlinkDelete(&mod
->node
, &module_list
);
410 ilog(L_MAIN
, "Module %s unloaded", name
);
411 sendto_realops_snomask(SNO_GENERAL
, L_ALL
, "Module %s unloaded", name
);
420 * inputs - path name of module, bool to notice, int of origin, bool if core
421 * output - false if error true if success
422 * side effects - loads a module if successful
425 load_a_module(const char *path
, bool warn
, int origin
, bool core
)
429 char *mod_displayname
, *c
;
430 const char *ver
, *description
= NULL
;
434 mod_displayname
= rb_basename(path
);
436 /* Trim off the ending for the display name if we have to */
437 if((c
= rb_strcasestr(mod_displayname
, LT_MODULE_EXT
)) != NULL
)
440 tmpptr
= lt_dlopenext(path
);
444 const char *err
= lt_dlerror();
446 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
447 "Error loading module %s: %s", mod_displayname
, err
);
448 ilog(L_MAIN
, "Error loading module %s: %s", mod_displayname
, err
);
449 rb_free(mod_displayname
);
454 * _mheader is actually a struct mapi_mheader_*, but mapi_version
455 * is always the first member of this structure, so we treate it
456 * as a single int in order to determine the API version.
459 mapi_version
= (int *) (uintptr_t) lt_dlsym(tmpptr
, "_mheader");
460 if((mapi_version
== NULL
461 && (mapi_version
= (int *) (uintptr_t) lt_dlsym(tmpptr
, "__mheader")) == NULL
)
462 || MAPI_MAGIC(*mapi_version
) != MAPI_MAGIC_HDR
)
464 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
465 "Data format error: module %s has no MAPI header.",
467 ilog(L_MAIN
, "Data format error: module %s has no MAPI header.", mod_displayname
);
468 (void) lt_dlclose(tmpptr
);
469 rb_free(mod_displayname
);
473 switch (MAPI_VERSION(*mapi_version
))
477 struct mapi_mheader_av1
*mheader
= (struct mapi_mheader_av1
*)(void *)mapi_version
; /* see above */
478 if(mheader
->mapi_register
&& (mheader
->mapi_register() == -1))
480 ilog(L_MAIN
, "Module %s indicated failure during load.",
482 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
483 "Module %s indicated failure during load.",
486 rb_free(mod_displayname
);
489 if(mheader
->mapi_command_list
)
492 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
496 if(mheader
->mapi_hook_list
)
499 for (m
= mheader
->mapi_hook_list
; m
->hapi_name
; ++m
)
500 *m
->hapi_id
= register_hook(m
->hapi_name
);
503 if(mheader
->mapi_hfn_list
)
505 mapi_hfn_list_av1
*m
;
506 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
507 add_hook(m
->hapi_name
, m
->fn
);
510 ver
= mheader
->mapi_module_version
;
515 struct mapi_mheader_av2
*mheader
= (struct mapi_mheader_av2
*)(void *)mapi_version
; /* see above */
517 /* XXX duplicated code :( */
518 if(mheader
->mapi_register
&& (mheader
->mapi_register() == -1))
520 ilog(L_MAIN
, "Module %s indicated failure during load.",
522 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
523 "Module %s indicated failure during load.",
526 rb_free(mod_displayname
);
530 /* Basic date code checks
532 * Don't make them fatal, but do complain about differences within a certain time frame.
533 * Later on if there are major API changes we can add fatal checks.
536 if(mheader
->mapi_datecode
!= datecode
&& mheader
->mapi_datecode
> 0)
538 long int delta
= datecode
- mheader
->mapi_datecode
;
539 if (delta
> MOD_WARN_DELTA
)
542 iwarn("Module %s build date is out of sync with ircd build date by %ld days, expect problems",
543 mod_displayname
, delta
);
544 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
545 "Module %s build date is out of sync with ircd build date by %ld days, expect problems",
546 mod_displayname
, delta
);
550 if(mheader
->mapi_command_list
)
553 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
557 if(mheader
->mapi_hook_list
)
560 for (m
= mheader
->mapi_hook_list
; m
->hapi_name
; ++m
)
561 *m
->hapi_id
= register_hook(m
->hapi_name
);
564 if(mheader
->mapi_hfn_list
)
566 mapi_hfn_list_av1
*m
;
567 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
568 add_hook(m
->hapi_name
, m
->fn
);
571 /* New in MAPI v2 - version replacement */
572 ver
= mheader
->mapi_module_version
? mheader
->mapi_module_version
: ircd_version
;
573 description
= mheader
->mapi_module_description
;
575 if(mheader
->mapi_cap_list
)
577 mapi_cap_list_av2
*m
;
578 for (m
= mheader
->mapi_cap_list
; m
->cap_name
; ++m
)
580 struct CapabilityIndex
*idx
;
583 switch (m
->cap_index
)
585 case MAPI_CAP_CLIENT
:
588 case MAPI_CAP_SERVER
:
592 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
593 "Unknown/unsupported CAP index found of type %d on capability %s when loading %s",
594 m
->cap_index
, m
->cap_name
, mod_displayname
);
596 "Unknown/unsupported CAP index found of type %d on capability %s when loading %s",
597 m
->cap_index
, m
->cap_name
, mod_displayname
);
601 result
= capability_put(idx
, m
->cap_name
, m
->cap_ownerdata
);
602 if (m
->cap_id
!= NULL
)
604 *(m
->cap_id
) = result
;
605 sendto_local_clients_with_capability(CLICAP_CAP_NOTIFY
, ":%s CAP * ADD :%s", me
.name
, m
->cap_name
);
613 ilog(L_MAIN
, "Module %s has unknown/unsupported MAPI version %d.",
614 mod_displayname
, MAPI_VERSION(*mapi_version
));
615 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
616 "Module %s has unknown/unsupported MAPI version %d.",
617 mod_displayname
, *mapi_version
);
619 rb_free(mod_displayname
);
626 if(description
== NULL
)
627 description
= unknown_description
;
629 mod
= rb_malloc(sizeof(struct module));
630 mod
->address
= tmpptr
;
632 mod
->description
= description
;
634 mod
->name
= rb_strdup(mod_displayname
);
635 mod
->mapi_header
= mapi_version
;
636 mod
->mapi_version
= MAPI_VERSION(*mapi_version
);
637 mod
->origin
= origin
;
638 rb_dlinkAdd(mod
, &mod
->node
, &module_list
);
646 case MAPI_ORIGIN_EXTENSION
:
649 case MAPI_ORIGIN_CORE
:
657 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
658 "Module %s [version: %s; MAPI version: %d; origin: %s; description: \"%s\"] loaded at %p",
659 mod_displayname
, ver
, MAPI_VERSION(*mapi_version
), o
, description
,
661 ilog(L_MAIN
, "Module %s [version: %s; MAPI version: %d; origin: %s; description: \"%s\"] loaded at %p",
662 mod_displayname
, ver
, MAPI_VERSION(*mapi_version
), o
, description
, (void *) tmpptr
);
664 rb_free(mod_displayname
);
669 modules_do_restart(void *unused
)
671 unsigned int modnum
= 0;
672 rb_dlink_node
*ptr
, *nptr
;
674 RB_DLINK_FOREACH_SAFE(ptr
, nptr
, module_list
.head
)
676 struct module *mod
= ptr
->data
;
677 if(!unload_one_module(mod
->name
, false))
679 ilog(L_MAIN
, "Module Restart: %s was not unloaded %s",
681 mod
->core
? "(core module)" : "");
684 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
,
685 "Module Restart: %s failed to unload",
693 load_all_modules(false);
694 load_core_modules(false);
697 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
,
698 "Module Restart: %u modules unloaded, %lu modules loaded",
699 modnum
, rb_dlink_list_length(&module_list
));
700 ilog(L_MAIN
, "Module Restart: %u modules unloaded, %lu modules loaded", modnum
, rb_dlink_list_length(&module_list
));