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
24 * $Id: modules.c 3161 2007-01-25 07:23:01Z nenolod $
36 #include "s_newconf.h"
39 #include "ircd_defs.h"
45 * I have moved the dl* function definitions and
46 * the two functions (load_a_module / unload_a_module) to the
48 * And also made the necessary changes to those functions
49 * to comply with shl_load and friends.
50 * In this file, to keep consistency with the makefile,
51 * I added the ability to load *.sl files, too.
55 #ifndef STATIC_MODULES
57 struct module **modlist
= NULL
;
59 static const char *core_module_table
[] = {
76 #define MODS_INCREMENT 10
78 int max_mods
= MODS_INCREMENT
;
80 static rb_dlink_list mod_paths
;
82 static int mo_modload(struct Client
*, struct Client
*, int, const char **);
83 static int mo_modlist(struct Client
*, struct Client
*, int, const char **);
84 static int mo_modreload(struct Client
*, struct Client
*, int, const char **);
85 static int mo_modunload(struct Client
*, struct Client
*, int, const char **);
86 static int mo_modrestart(struct Client
*, struct Client
*, int, const char **);
88 struct Message modload_msgtab
= {
89 "MODLOAD", 0, 0, 0, MFLG_SLOW
,
90 {mg_unreg
, mg_not_oper
, mg_ignore
, mg_ignore
, mg_ignore
, {mo_modload
, 2}}
93 struct Message modunload_msgtab
= {
94 "MODUNLOAD", 0, 0, 0, MFLG_SLOW
,
95 {mg_unreg
, mg_not_oper
, mg_ignore
, mg_ignore
, mg_ignore
, {mo_modunload
, 2}}
98 struct Message modreload_msgtab
= {
99 "MODRELOAD", 0, 0, 0, MFLG_SLOW
,
100 {mg_unreg
, mg_not_oper
, mg_ignore
, mg_ignore
, mg_ignore
, {mo_modreload
, 2}}
103 struct Message modlist_msgtab
= {
104 "MODLIST", 0, 0, 0, MFLG_SLOW
,
105 {mg_unreg
, mg_not_oper
, mg_ignore
, mg_ignore
, mg_ignore
, {mo_modlist
, 0}}
108 struct Message modrestart_msgtab
= {
109 "MODRESTART", 0, 0, 0, MFLG_SLOW
,
110 {mg_unreg
, mg_not_oper
, mg_ignore
, mg_ignore
, mg_ignore
, {mo_modrestart
, 0}}
116 mod_add_cmd(&modload_msgtab
);
117 mod_add_cmd(&modunload_msgtab
);
118 mod_add_cmd(&modreload_msgtab
);
119 mod_add_cmd(&modlist_msgtab
);
120 mod_add_cmd(&modrestart_msgtab
);
122 /* Add the default paths we look in to the module system --nenolod */
123 mod_add_path(MODPATH
);
124 mod_add_path(AUTOMODPATH
);
131 * side effects - returns a module path from path
133 static struct module_path
*
134 mod_find_path(const char *path
)
137 struct module_path
*mpath
;
139 RB_DLINK_FOREACH(ptr
, mod_paths
.head
)
143 if(!strcmp(path
, mpath
->path
))
154 * side effects - adds path to list
157 mod_add_path(const char *path
)
159 struct module_path
*pathst
;
161 if(mod_find_path(path
))
164 pathst
= rb_malloc(sizeof(struct module_path
));
166 strcpy(pathst
->path
, path
);
167 rb_dlinkAddAlloc(pathst
, &mod_paths
);
174 * side effects - clear the lists of paths
177 mod_clear_paths(void)
179 rb_dlink_node
*ptr
, *next_ptr
;
181 RB_DLINK_FOREACH_SAFE(ptr
, next_ptr
, mod_paths
.head
)
184 rb_free_rb_dlink_node(ptr
);
187 mod_paths
.head
= mod_paths
.tail
= NULL
;
188 mod_paths
.length
= 0;
199 findmodule_byname(const char *name
)
203 for (i
= 0; i
< num_mods
; i
++)
205 if(!irccmp(modlist
[i
]->name
, name
))
211 /* load_all_modules()
218 load_all_modules(int warn
)
220 DIR *system_module_dir
= NULL
;
221 struct dirent
*ldirent
= NULL
;
222 char module_fq_name
[PATH_MAX
+ 1];
227 modlist
= (struct module **) rb_malloc(sizeof(struct module) * (MODS_INCREMENT
));
229 max_mods
= MODS_INCREMENT
;
231 system_module_dir
= opendir(AUTOMODPATH
);
233 if(system_module_dir
== NULL
)
235 ilog(L_MAIN
, "Could not load modules from %s: %s", AUTOMODPATH
, strerror(errno
));
239 while ((ldirent
= readdir(system_module_dir
)) != NULL
)
241 len
= strlen(ldirent
->d_name
);
242 if((len
> 3) && !strcmp(ldirent
->d_name
+len
-3, SHARED_SUFFIX
))
244 (void) rb_snprintf(module_fq_name
, sizeof(module_fq_name
), "%s/%s", AUTOMODPATH
, ldirent
->d_name
);
245 (void) load_a_module(module_fq_name
, warn
, 0);
249 (void) closedir(system_module_dir
);
252 /* load_core_modules()
256 * side effects - core modules are loaded, if any fail, kill ircd
259 load_core_modules(int warn
)
261 char module_name
[MAXPATHLEN
];
265 for (i
= 0; core_module_table
[i
]; i
++)
267 rb_snprintf(module_name
, sizeof(module_name
), "%s/%s%s", MODPATH
,
268 core_module_table
[i
], SHARED_SUFFIX
);
270 if(load_a_module(module_name
, warn
, 1) == -1)
273 "Error loading core module %s%s: terminating ircd",
274 core_module_table
[i
], SHARED_SUFFIX
);
287 load_one_module(const char *path
, int coremodule
)
289 char modpath
[MAXPATHLEN
];
290 rb_dlink_node
*pathst
;
291 struct module_path
*mpath
;
295 if (server_state_foreground
== 1)
296 inotice("loading module %s ...", path
);
298 RB_DLINK_FOREACH(pathst
, mod_paths
.head
)
300 mpath
= pathst
->data
;
302 rb_snprintf(modpath
, sizeof(modpath
), "%s/%s", mpath
->path
, path
);
303 if((strstr(modpath
, "../") == NULL
) && (strstr(modpath
, "/..") == NULL
))
305 if(stat(modpath
, &statbuf
) == 0)
307 if(S_ISREG(statbuf
.st_mode
))
309 /* Regular files only please */
311 return load_a_module(modpath
, 1, 1);
313 return load_a_module(modpath
, 1, 0);
320 sendto_realops_snomask(SNO_GENERAL
, L_ALL
, "Cannot locate module %s", path
);
325 /* load a module .. */
327 mo_modload(struct Client
*client_p
, struct Client
*source_p
, int parc
, const char **parv
)
331 if(!IsOperAdmin(source_p
))
333 sendto_one(source_p
, form_str(ERR_NOPRIVS
),
334 me
.name
, source_p
->name
, "admin");
338 m_bn
= rb_basename(parv
[1]);
340 if(findmodule_byname(m_bn
) != -1)
342 sendto_one_notice(source_p
, ":Module %s is already loaded", m_bn
);
347 load_one_module(parv
[1], 0);
355 /* unload a module .. */
357 mo_modunload(struct Client
*client_p
, struct Client
*source_p
, int parc
, const char **parv
)
362 if(!IsOperAdmin(source_p
))
364 sendto_one(source_p
, form_str(ERR_NOPRIVS
),
365 me
.name
, source_p
->name
, "admin");
369 m_bn
= rb_basename(parv
[1]);
371 if((modindex
= findmodule_byname(m_bn
)) == -1)
373 sendto_one_notice(source_p
, ":Module %s is not loaded", m_bn
);
378 if(modlist
[modindex
]->core
== 1)
380 sendto_one_notice(source_p
, ":Module %s is a core module and may not be unloaded", m_bn
);
385 if(unload_one_module(m_bn
, 1) == -1)
387 sendto_one_notice(source_p
, ":Module %s is not loaded", m_bn
);
394 /* unload and load in one! */
396 mo_modreload(struct Client
*client_p
, struct Client
*source_p
, int parc
, const char **parv
)
402 if(!IsOperAdmin(source_p
))
404 sendto_one(source_p
, form_str(ERR_NOPRIVS
),
405 me
.name
, source_p
->name
, "admin");
409 m_bn
= rb_basename(parv
[1]);
411 if((modindex
= findmodule_byname(m_bn
)) == -1)
413 sendto_one_notice(source_p
, ":Module %s is not loaded", m_bn
);
418 check_core
= modlist
[modindex
]->core
;
420 if(unload_one_module(m_bn
, 1) == -1)
422 sendto_one_notice(source_p
, ":Module %s is not loaded", m_bn
);
427 if((load_one_module(m_bn
, check_core
) == -1) && check_core
)
429 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
430 "Error reloading core module: %s: terminating ircd", m_bn
);
431 ilog(L_MAIN
, "Error loading core module %s: terminating ircd", m_bn
);
439 /* list modules .. */
441 mo_modlist(struct Client
*client_p
, struct Client
*source_p
, int parc
, const char **parv
)
445 if(!IsOperAdmin(source_p
))
447 sendto_one(source_p
, form_str(ERR_NOPRIVS
),
448 me
.name
, source_p
->name
, "admin");
452 for (i
= 0; i
< num_mods
; i
++)
456 if(match(parv
[1], modlist
[i
]->name
))
458 sendto_one(source_p
, form_str(RPL_MODLIST
),
459 me
.name
, source_p
->name
,
462 modlist
[i
]->version
, modlist
[i
]->core
? "(core)" : "");
467 sendto_one(source_p
, form_str(RPL_MODLIST
),
468 me
.name
, source_p
->name
, modlist
[i
]->name
,
469 modlist
[i
]->address
, modlist
[i
]->version
,
470 modlist
[i
]->core
? "(core)" : "");
474 sendto_one(source_p
, form_str(RPL_ENDOFMODLIST
), me
.name
, source_p
->name
);
478 /* unload and reload all modules */
480 mo_modrestart(struct Client
*client_p
, struct Client
*source_p
, int parc
, const char **parv
)
484 if(!IsOperAdmin(source_p
))
486 sendto_one(source_p
, form_str(ERR_NOPRIVS
),
487 me
.name
, source_p
->name
, "admin");
491 sendto_one_notice(source_p
, ":Reloading all modules");
495 unload_one_module(modlist
[0]->name
, 0);
498 load_core_modules(0);
501 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
502 "Module Restart: %d modules unloaded, %d modules loaded",
504 ilog(L_MAIN
, "Module Restart: %d modules unloaded, %d modules loaded", modnum
, num_mods
);
511 #define RTLD_NOW RTLD_LAZY /* openbsd deficiency */
518 #ifdef CHARYBDIS_PROFILE
519 # ifndef RTLD_PROFILE
520 # warning libdl may not support profiling, sucks. :(
521 # define RTLD_PROFILE 0
525 static void increase_modlist(void);
527 #define MODS_INCREMENT 10
529 static char unknown_ver
[] = "<unknown>";
531 /* This file contains the core functions to use dynamic libraries.
536 #ifdef HAVE_MACH_O_DYLD_H
538 ** jmallett's dl*(3) shims for NSModule(3) systems.
540 #include <mach-o/dyld.h>
544 #define RTLD_LAZY 2185 /* built-in dl*(3) don't care */
547 void undefinedErrorHandler(const char *);
548 NSModule
multipleErrorHandler(NSSymbol
, NSModule
, NSModule
);
549 void linkEditErrorHandler(NSLinkEditErrors
, int, const char *, const char *);
551 void *dlopen(char *, int);
553 void *dlsym(void *, char *);
555 static int firstLoad
= TRUE
;
556 static int myDlError
;
557 static char *myErrorTable
[] = { "Loading file as object failed\n",
558 "Loading file as object succeeded\n",
559 "Not a valid shared object\n",
560 "Architecture of object invalid on this architecture\n",
561 "Invalid or corrupt image\n",
562 "Could not access object\n",
563 "NSCreateObjectFileImageFromFile failed\n",
568 undefinedErrorHandler(const char *symbolName
)
570 sendto_realops_snomask(SNO_GENERAL
, L_ALL
, "Undefined symbol: %s", symbolName
);
571 ilog(L_MAIN
, "Undefined symbol: %s", symbolName
);
576 multipleErrorHandler(NSSymbol s
, NSModule old
, NSModule
new)
579 ** This results in substantial leaking of memory... Should free one
582 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
583 "Symbol `%s' found in `%s' and `%s'",
584 NSNameOfSymbol(s
), NSNameOfModule(old
), NSNameOfModule(new));
585 ilog(L_MAIN
, "Symbol `%s' found in `%s' and `%s'",
586 NSNameOfSymbol(s
), NSNameOfModule(old
), NSNameOfModule(new));
587 /* We return which module should be considered valid, I believe */
592 linkEditErrorHandler(NSLinkEditErrors errorClass
, int errnum
,
593 const char *fileName
, const char *errorString
)
595 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
596 "Link editor error: %s for %s", errorString
, fileName
);
597 ilog(L_MAIN
, "Link editor error: %s for %s", errorString
, fileName
);
604 return myDlError
== NSObjectFileImageSuccess
? NULL
: myErrorTable
[myDlError
% 7];
608 dlopen(char *filename
, int unused
)
610 NSObjectFileImage myImage
;
616 ** If we are loading our first symbol (huzzah!) we should go ahead
617 ** and install link editor error handling!
619 NSLinkEditErrorHandlers linkEditorErrorHandlers
;
621 linkEditorErrorHandlers
.undefined
= undefinedErrorHandler
;
622 linkEditorErrorHandlers
.multiple
= multipleErrorHandler
;
623 linkEditorErrorHandlers
.linkEdit
= linkEditErrorHandler
;
624 NSInstallLinkEditErrorHandlers(&linkEditorErrorHandlers
);
627 myDlError
= NSCreateObjectFileImageFromFile(filename
, &myImage
);
628 if(myDlError
!= NSObjectFileImageSuccess
)
632 myModule
= NSLinkModule(myImage
, filename
, NSLINKMODULE_OPTION_PRIVATE
);
633 return (void *) myModule
;
637 dlclose(void *myModule
)
639 NSUnLinkModule(myModule
, FALSE
);
644 dlsym(void *myModule
, char *mySymbolName
)
648 mySymbol
= NSLookupSymbolInModule((NSModule
) myModule
, mySymbolName
);
649 return NSAddressOfSymbol(mySymbol
);
656 * HPUX dl compat functions
658 #if defined(HAVE_SHL_LOAD) && !defined(HAVE_DLOPEN)
659 #define RTLD_LAZY BIND_DEFERRED
660 #define RTLD_GLOBAL DYNAMIC_PATH
661 #define dlopen(file,mode) (void *)shl_load((file), (mode), (long) 0)
662 #define dlclose(handle) shl_unload((shl_t)(handle))
663 #define dlsym(handle,name) hpux_dlsym(handle,name)
664 #define dlerror() strerror(errno)
667 hpux_dlsym(void *handle
, char *name
)
670 if(!shl_findsym((shl_t
*) & handle
, name
, TYPE_UNDEFINED
, &sym_addr
))
677 /* unload_one_module()
679 * inputs - name of module to unload
680 * - 1 to say modules unloaded, 0 to not
681 * output - 0 if successful, -1 if error
682 * side effects - module is unloaded
685 unload_one_module(const char *name
, int warn
)
689 if((modindex
= findmodule_byname(name
)) == -1)
693 ** XXX - The type system in C does not allow direct conversion between
694 ** data and function pointers, but as it happens, most C compilers will
695 ** safely do this, however it is a theoretical overlow to cast as we
696 ** must do here. I have library functions to take care of this, but
697 ** despite being more "correct" for the C language, this is more
698 ** practical. Removing the abuse of the ability to cast ANY pointer
699 ** to and from an integer value here will break some compilers.
702 /* Left the comment in but the code isn't here any more -larne */
703 switch (modlist
[modindex
]->mapi_version
)
707 struct mapi_mheader_av1
*mheader
= modlist
[modindex
]->mapi_header
;
708 if(mheader
->mapi_command_list
)
711 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
715 /* hook events are never removed, we simply lose the
716 * ability to call them --fl
718 if(mheader
->mapi_hfn_list
)
720 mapi_hfn_list_av1
*m
;
721 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
722 remove_hook(m
->hapi_name
, m
->fn
);
725 if(mheader
->mapi_unregister
)
726 mheader
->mapi_unregister();
730 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
731 "Unknown/unsupported MAPI version %d when unloading %s!",
732 modlist
[modindex
]->mapi_version
, modlist
[modindex
]->name
);
733 ilog(L_MAIN
, "Unknown/unsupported MAPI version %d when unloading %s!",
734 modlist
[modindex
]->mapi_version
, modlist
[modindex
]->name
);
738 dlclose(modlist
[modindex
]->address
);
740 rb_free(modlist
[modindex
]->name
);
741 memmove(&modlist
[modindex
], &modlist
[modindex
+ 1],
742 sizeof(struct module) * ((num_mods
- 1) - modindex
));
749 ilog(L_MAIN
, "Module %s unloaded", name
);
750 sendto_realops_snomask(SNO_GENERAL
, L_ALL
, "Module %s unloaded", name
);
760 * inputs - path name of module, int to notice, int of core
761 * output - -1 if error 0 if success
762 * side effects - loads a module if successful
765 load_a_module(const char *path
, int warn
, int core
)
774 mod_basename
= rb_basename(path
);
776 #ifdef CHARYBDIS_PROFILE
777 tmpptr
= dlopen(path
, RTLD_NOW
| RTLD_LOCAL
| RTLD_PROFILE
);
779 tmpptr
= dlopen(path
, RTLD_NOW
| RTLD_LOCAL
);
784 const char *err
= dlerror();
786 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
787 "Error loading module %s: %s", mod_basename
, err
);
788 ilog(L_MAIN
, "Error loading module %s: %s", mod_basename
, err
);
789 rb_free(mod_basename
);
795 * _mheader is actually a struct mapi_mheader_*, but mapi_version
796 * is always the first member of this structure, so we treate it
797 * as a single int in order to determine the API version.
800 mapi_version
= (int *) (uintptr_t) dlsym(tmpptr
, "_mheader");
801 if((mapi_version
== NULL
802 && (mapi_version
= (int *) (uintptr_t) dlsym(tmpptr
, "__mheader")) == NULL
)
803 || MAPI_MAGIC(*mapi_version
) != MAPI_MAGIC_HDR
)
805 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
806 "Data format error: module %s has no MAPI header.",
808 ilog(L_MAIN
, "Data format error: module %s has no MAPI header.", mod_basename
);
809 (void) dlclose(tmpptr
);
810 rb_free(mod_basename
);
814 switch (MAPI_VERSION(*mapi_version
))
818 struct mapi_mheader_av1
*mheader
= (struct mapi_mheader_av1
*) mapi_version
; /* see above */
819 if(mheader
->mapi_register
&& (mheader
->mapi_register() == -1))
821 ilog(L_MAIN
, "Module %s indicated failure during load.",
823 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
824 "Module %s indicated failure during load.",
827 rb_free(mod_basename
);
830 if(mheader
->mapi_command_list
)
833 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
837 if(mheader
->mapi_hook_list
)
840 for (m
= mheader
->mapi_hook_list
; m
->hapi_name
; ++m
)
841 *m
->hapi_id
= register_hook(m
->hapi_name
);
844 if(mheader
->mapi_hfn_list
)
846 mapi_hfn_list_av1
*m
;
847 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
848 add_hook(m
->hapi_name
, m
->fn
);
851 ver
= mheader
->mapi_module_version
;
856 ilog(L_MAIN
, "Module %s has unknown/unsupported MAPI version %d.",
857 mod_basename
, MAPI_VERSION(*mapi_version
));
858 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
859 "Module %s has unknown/unsupported MAPI version %d.",
860 mod_basename
, *mapi_version
);
862 rb_free(mod_basename
);
871 modlist
[num_mods
] = rb_malloc(sizeof(struct module));
872 modlist
[num_mods
]->address
= tmpptr
;
873 modlist
[num_mods
]->version
= ver
;
874 modlist
[num_mods
]->core
= core
;
875 modlist
[num_mods
]->name
= rb_strdup(mod_basename
);
876 modlist
[num_mods
]->mapi_header
= mapi_version
;
877 modlist
[num_mods
]->mapi_version
= MAPI_VERSION(*mapi_version
);
882 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
883 "Module %s [version: %s; MAPI version: %d] loaded at 0x%lx",
884 mod_basename
, ver
, MAPI_VERSION(*mapi_version
),
885 (unsigned long) tmpptr
);
886 ilog(L_MAIN
, "Module %s [version: %s; MAPI version: %d] loaded at 0x%lx",
887 mod_basename
, ver
, MAPI_VERSION(*mapi_version
), (unsigned long) tmpptr
);
889 rb_free(mod_basename
);
898 * side effects - expand the size of modlist if necessary
901 increase_modlist(void)
903 struct module **new_modlist
= NULL
;
905 if((num_mods
+ 1) < max_mods
)
908 new_modlist
= (struct module **) rb_malloc(sizeof(struct module) *
909 (max_mods
+ MODS_INCREMENT
));
910 memcpy((void *) new_modlist
, (void *) modlist
, sizeof(struct module) * num_mods
);
913 modlist
= new_modlist
;
914 max_mods
+= MODS_INCREMENT
;
917 #else /* STATIC_MODULES */
919 /* load_all_modules()
923 * side effects - all the msgtabs are added for static modules
926 load_all_modules(int warn
)
928 load_static_modules();
931 #endif /* STATIC_MODULES */