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"
40 #include "irc_string.h"
41 #include "sprintf_irc.h"
46 * I have moved the dl* function definitions and
47 * the two functions (load_a_module / unload_a_module) to the
49 * And also made the necessary changes to those functions
50 * to comply with shl_load and friends.
51 * In this file, to keep consistency with the makefile,
52 * I added the ability to load *.sl files, too.
56 #ifndef STATIC_MODULES
58 struct module **modlist
= NULL
;
60 static const char *core_module_table
[] = {
77 #define MODS_INCREMENT 10
79 int max_mods
= MODS_INCREMENT
;
81 static rb_dlink_list mod_paths
;
83 static int mo_modload(struct Client
*, struct Client
*, int, const char **);
84 static int mo_modlist(struct Client
*, struct Client
*, int, const char **);
85 static int mo_modreload(struct Client
*, struct Client
*, int, const char **);
86 static int mo_modunload(struct Client
*, struct Client
*, int, const char **);
87 static int mo_modrestart(struct Client
*, struct Client
*, int, const char **);
89 struct Message modload_msgtab
= {
90 "MODLOAD", 0, 0, 0, MFLG_SLOW
,
91 {mg_unreg
, mg_not_oper
, mg_ignore
, mg_ignore
, mg_ignore
, {mo_modload
, 2}}
94 struct Message modunload_msgtab
= {
95 "MODUNLOAD", 0, 0, 0, MFLG_SLOW
,
96 {mg_unreg
, mg_not_oper
, mg_ignore
, mg_ignore
, mg_ignore
, {mo_modunload
, 2}}
99 struct Message modreload_msgtab
= {
100 "MODRELOAD", 0, 0, 0, MFLG_SLOW
,
101 {mg_unreg
, mg_not_oper
, mg_ignore
, mg_ignore
, mg_ignore
, {mo_modreload
, 2}}
104 struct Message modlist_msgtab
= {
105 "MODLIST", 0, 0, 0, MFLG_SLOW
,
106 {mg_unreg
, mg_not_oper
, mg_ignore
, mg_ignore
, mg_ignore
, {mo_modlist
, 0}}
109 struct Message modrestart_msgtab
= {
110 "MODRESTART", 0, 0, 0, MFLG_SLOW
,
111 {mg_unreg
, mg_not_oper
, mg_ignore
, mg_ignore
, mg_ignore
, {mo_modrestart
, 0}}
114 extern struct Message error_msgtab
;
119 mod_add_cmd(&modload_msgtab
);
120 mod_add_cmd(&modunload_msgtab
);
121 mod_add_cmd(&modreload_msgtab
);
122 mod_add_cmd(&modlist_msgtab
);
123 mod_add_cmd(&modrestart_msgtab
);
125 /* Add the default paths we look in to the module system --nenolod */
126 mod_add_path(MODPATH
);
127 mod_add_path(AUTOMODPATH
);
134 * side effects - returns a module path from path
136 static struct module_path
*
137 mod_find_path(const char *path
)
140 struct module_path
*mpath
;
142 RB_DLINK_FOREACH(ptr
, mod_paths
.head
)
146 if(!strcmp(path
, mpath
->path
))
157 * side effects - adds path to list
160 mod_add_path(const char *path
)
162 struct module_path
*pathst
;
164 if(mod_find_path(path
))
167 pathst
= rb_malloc(sizeof(struct module_path
));
169 strcpy(pathst
->path
, path
);
170 rb_dlinkAddAlloc(pathst
, &mod_paths
);
177 * side effects - clear the lists of paths
180 mod_clear_paths(void)
182 rb_dlink_node
*ptr
, *next_ptr
;
184 RB_DLINK_FOREACH_SAFE(ptr
, next_ptr
, mod_paths
.head
)
187 rb_free_rb_dlink_node(ptr
);
190 mod_paths
.head
= mod_paths
.tail
= NULL
;
191 mod_paths
.length
= 0;
201 irc_basename(const char *path
)
203 char *mod_basename
= rb_malloc(strlen(path
) + 1);
206 if(!(s
= strrchr(path
, '/')))
211 (void) strcpy(mod_basename
, s
);
223 findmodule_byname(const char *name
)
227 for (i
= 0; i
< num_mods
; i
++)
229 if(!irccmp(modlist
[i
]->name
, name
))
235 /* load_all_modules()
242 load_all_modules(int warn
)
244 DIR *system_module_dir
= NULL
;
245 struct dirent
*ldirent
= NULL
;
246 char module_fq_name
[PATH_MAX
+ 1];
251 modlist
= (struct module **) rb_malloc(sizeof(struct module) * (MODS_INCREMENT
));
253 max_mods
= MODS_INCREMENT
;
255 system_module_dir
= opendir(AUTOMODPATH
);
257 if(system_module_dir
== NULL
)
259 ilog(L_MAIN
, "Could not load modules from %s: %s", AUTOMODPATH
, strerror(errno
));
263 while ((ldirent
= readdir(system_module_dir
)) != NULL
)
265 len
= strlen(ldirent
->d_name
);
266 if((len
> 3) && !strcmp(ldirent
->d_name
+len
-3, SHARED_SUFFIX
))
268 (void) rb_snprintf(module_fq_name
, sizeof(module_fq_name
), "%s/%s", AUTOMODPATH
, ldirent
->d_name
);
269 (void) load_a_module(module_fq_name
, warn
, 0);
273 (void) closedir(system_module_dir
);
276 /* load_core_modules()
280 * side effects - core modules are loaded, if any fail, kill ircd
283 load_core_modules(int warn
)
285 char module_name
[MAXPATHLEN
];
289 for (i
= 0; core_module_table
[i
]; i
++)
291 rb_snprintf(module_name
, sizeof(module_name
), "%s/%s%s", MODPATH
,
292 core_module_table
[i
], SHARED_SUFFIX
);
294 if(load_a_module(module_name
, warn
, 1) == -1)
297 "Error loading core module %s%s: terminating ircd",
298 core_module_table
[i
], SHARED_SUFFIX
);
311 load_one_module(const char *path
, int coremodule
)
313 char modpath
[MAXPATHLEN
];
314 rb_dlink_node
*pathst
;
315 struct module_path
*mpath
;
319 if (server_state_foreground
== 1)
320 inotice("loading module %s ...", path
);
322 RB_DLINK_FOREACH(pathst
, mod_paths
.head
)
324 mpath
= pathst
->data
;
326 rb_snprintf(modpath
, sizeof(modpath
), "%s/%s", mpath
->path
, path
);
327 if((strstr(modpath
, "../") == NULL
) && (strstr(modpath
, "/..") == NULL
))
329 if(stat(modpath
, &statbuf
) == 0)
331 if(S_ISREG(statbuf
.st_mode
))
333 /* Regular files only please */
335 return load_a_module(modpath
, 1, 1);
337 return load_a_module(modpath
, 1, 0);
344 sendto_realops_snomask(SNO_GENERAL
, L_ALL
, "Cannot locate module %s", path
);
349 /* load a module .. */
351 mo_modload(struct Client
*client_p
, struct Client
*source_p
, int parc
, const char **parv
)
355 if(!IsOperAdmin(source_p
))
357 sendto_one(source_p
, form_str(ERR_NOPRIVS
),
358 me
.name
, source_p
->name
, "admin");
362 m_bn
= irc_basename(parv
[1]);
364 if(findmodule_byname(m_bn
) != -1)
366 sendto_one_notice(source_p
, ":Module %s is already loaded", m_bn
);
371 load_one_module(parv
[1], 0);
379 /* unload a module .. */
381 mo_modunload(struct Client
*client_p
, struct Client
*source_p
, int parc
, const char **parv
)
386 if(!IsOperAdmin(source_p
))
388 sendto_one(source_p
, form_str(ERR_NOPRIVS
),
389 me
.name
, source_p
->name
, "admin");
393 m_bn
= irc_basename(parv
[1]);
395 if((modindex
= findmodule_byname(m_bn
)) == -1)
397 sendto_one_notice(source_p
, ":Module %s is not loaded", m_bn
);
402 if(modlist
[modindex
]->core
== 1)
404 sendto_one_notice(source_p
, ":Module %s is a core module and may not be unloaded", m_bn
);
409 if(unload_one_module(m_bn
, 1) == -1)
411 sendto_one_notice(source_p
, ":Module %s is not loaded", m_bn
);
418 /* unload and load in one! */
420 mo_modreload(struct Client
*client_p
, struct Client
*source_p
, int parc
, const char **parv
)
426 if(!IsOperAdmin(source_p
))
428 sendto_one(source_p
, form_str(ERR_NOPRIVS
),
429 me
.name
, source_p
->name
, "admin");
433 m_bn
= irc_basename(parv
[1]);
435 if((modindex
= findmodule_byname(m_bn
)) == -1)
437 sendto_one_notice(source_p
, ":Module %s is not loaded", m_bn
);
442 check_core
= modlist
[modindex
]->core
;
444 if(unload_one_module(m_bn
, 1) == -1)
446 sendto_one_notice(source_p
, ":Module %s is not loaded", m_bn
);
451 if((load_one_module(parv
[1], check_core
) == -1) && check_core
)
453 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
454 "Error reloading core module: %s: terminating ircd", parv
[1]);
455 ilog(L_MAIN
, "Error loading core module %s: terminating ircd", parv
[1]);
463 /* list modules .. */
465 mo_modlist(struct Client
*client_p
, struct Client
*source_p
, int parc
, const char **parv
)
469 if(!IsOperAdmin(source_p
))
471 sendto_one(source_p
, form_str(ERR_NOPRIVS
),
472 me
.name
, source_p
->name
, "admin");
476 for (i
= 0; i
< num_mods
; i
++)
480 if(match(parv
[1], modlist
[i
]->name
))
482 sendto_one(source_p
, form_str(RPL_MODLIST
),
483 me
.name
, source_p
->name
,
486 modlist
[i
]->version
, modlist
[i
]->core
? "(core)" : "");
491 sendto_one(source_p
, form_str(RPL_MODLIST
),
492 me
.name
, source_p
->name
, modlist
[i
]->name
,
493 modlist
[i
]->address
, modlist
[i
]->version
,
494 modlist
[i
]->core
? "(core)" : "");
498 sendto_one(source_p
, form_str(RPL_ENDOFMODLIST
), me
.name
, source_p
->name
);
502 /* unload and reload all modules */
504 mo_modrestart(struct Client
*client_p
, struct Client
*source_p
, int parc
, const char **parv
)
508 if(!IsOperAdmin(source_p
))
510 sendto_one(source_p
, form_str(ERR_NOPRIVS
),
511 me
.name
, source_p
->name
, "admin");
515 sendto_one_notice(source_p
, ":Reloading all modules");
519 unload_one_module(modlist
[0]->name
, 0);
522 load_core_modules(0);
525 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
526 "Module Restart: %d modules unloaded, %d modules loaded",
528 ilog(L_MAIN
, "Module Restart: %d modules unloaded, %d modules loaded", modnum
, num_mods
);
535 #define RTLD_NOW RTLD_LAZY /* openbsd deficiency */
538 #ifdef CHARYBDIS_PROFILE
539 # ifndef RTLD_PROFILE
540 # warning libdl may not support profiling, sucks. :(
541 # define RTLD_PROFILE 0
545 static void increase_modlist(void);
547 #define MODS_INCREMENT 10
549 static char unknown_ver
[] = "<unknown>";
551 /* This file contains the core functions to use dynamic libraries.
556 #ifdef HAVE_MACH_O_DYLD_H
558 ** jmallett's dl*(3) shims for NSModule(3) systems.
560 #include <mach-o/dyld.h>
564 #define RTLD_LAZY 2185 /* built-in dl*(3) don't care */
567 void undefinedErrorHandler(const char *);
568 NSModule
multipleErrorHandler(NSSymbol
, NSModule
, NSModule
);
569 void linkEditErrorHandler(NSLinkEditErrors
, int, const char *, const char *);
571 void *dlopen(char *, int);
573 void *dlsym(void *, char *);
575 static int firstLoad
= TRUE
;
576 static int myDlError
;
577 static char *myErrorTable
[] = { "Loading file as object failed\n",
578 "Loading file as object succeeded\n",
579 "Not a valid shared object\n",
580 "Architecture of object invalid on this architecture\n",
581 "Invalid or corrupt image\n",
582 "Could not access object\n",
583 "NSCreateObjectFileImageFromFile failed\n",
588 undefinedErrorHandler(const char *symbolName
)
590 sendto_realops_snomask(SNO_GENERAL
, L_ALL
, "Undefined symbol: %s", symbolName
);
591 ilog(L_MAIN
, "Undefined symbol: %s", symbolName
);
596 multipleErrorHandler(NSSymbol s
, NSModule old
, NSModule
new)
599 ** This results in substantial leaking of memory... Should free one
602 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
603 "Symbol `%s' found in `%s' and `%s'",
604 NSNameOfSymbol(s
), NSNameOfModule(old
), NSNameOfModule(new));
605 ilog(L_MAIN
, "Symbol `%s' found in `%s' and `%s'",
606 NSNameOfSymbol(s
), NSNameOfModule(old
), NSNameOfModule(new));
607 /* We return which module should be considered valid, I believe */
612 linkEditErrorHandler(NSLinkEditErrors errorClass
, int errnum
,
613 const char *fileName
, const char *errorString
)
615 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
616 "Link editor error: %s for %s", errorString
, fileName
);
617 ilog(L_MAIN
, "Link editor error: %s for %s", errorString
, fileName
);
624 return myDlError
== NSObjectFileImageSuccess
? NULL
: myErrorTable
[myDlError
% 7];
628 dlopen(char *filename
, int unused
)
630 NSObjectFileImage myImage
;
636 ** If we are loading our first symbol (huzzah!) we should go ahead
637 ** and install link editor error handling!
639 NSLinkEditErrorHandlers linkEditorErrorHandlers
;
641 linkEditorErrorHandlers
.undefined
= undefinedErrorHandler
;
642 linkEditorErrorHandlers
.multiple
= multipleErrorHandler
;
643 linkEditorErrorHandlers
.linkEdit
= linkEditErrorHandler
;
644 NSInstallLinkEditErrorHandlers(&linkEditorErrorHandlers
);
647 myDlError
= NSCreateObjectFileImageFromFile(filename
, &myImage
);
648 if(myDlError
!= NSObjectFileImageSuccess
)
652 myModule
= NSLinkModule(myImage
, filename
, NSLINKMODULE_OPTION_PRIVATE
);
653 return (void *) myModule
;
657 dlclose(void *myModule
)
659 NSUnLinkModule(myModule
, FALSE
);
664 dlsym(void *myModule
, char *mySymbolName
)
668 mySymbol
= NSLookupSymbolInModule((NSModule
) myModule
, mySymbolName
);
669 return NSAddressOfSymbol(mySymbol
);
676 * HPUX dl compat functions
678 #if defined(HAVE_SHL_LOAD) && !defined(HAVE_DLOPEN)
679 #define RTLD_LAZY BIND_DEFERRED
680 #define RTLD_GLOBAL DYNAMIC_PATH
681 #define dlopen(file,mode) (void *)shl_load((file), (mode), (long) 0)
682 #define dlclose(handle) shl_unload((shl_t)(handle))
683 #define dlsym(handle,name) hpux_dlsym(handle,name)
684 #define dlerror() strerror(errno)
687 hpux_dlsym(void *handle
, char *name
)
690 if(!shl_findsym((shl_t
*) & handle
, name
, TYPE_UNDEFINED
, &sym_addr
))
697 /* unload_one_module()
699 * inputs - name of module to unload
700 * - 1 to say modules unloaded, 0 to not
701 * output - 0 if successful, -1 if error
702 * side effects - module is unloaded
705 unload_one_module(const char *name
, int warn
)
709 if((modindex
= findmodule_byname(name
)) == -1)
713 ** XXX - The type system in C does not allow direct conversion between
714 ** data and function pointers, but as it happens, most C compilers will
715 ** safely do this, however it is a theoretical overlow to cast as we
716 ** must do here. I have library functions to take care of this, but
717 ** despite being more "correct" for the C language, this is more
718 ** practical. Removing the abuse of the ability to cast ANY pointer
719 ** to and from an integer value here will break some compilers.
722 /* Left the comment in but the code isn't here any more -larne */
723 switch (modlist
[modindex
]->mapi_version
)
727 struct mapi_mheader_av1
*mheader
= modlist
[modindex
]->mapi_header
;
728 if(mheader
->mapi_command_list
)
731 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
735 /* hook events are never removed, we simply lose the
736 * ability to call them --fl
738 if(mheader
->mapi_hfn_list
)
740 mapi_hfn_list_av1
*m
;
741 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
742 remove_hook(m
->hapi_name
, m
->fn
);
745 if(mheader
->mapi_unregister
)
746 mheader
->mapi_unregister();
750 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
751 "Unknown/unsupported MAPI version %d when unloading %s!",
752 modlist
[modindex
]->mapi_version
, modlist
[modindex
]->name
);
753 ilog(L_MAIN
, "Unknown/unsupported MAPI version %d when unloading %s!",
754 modlist
[modindex
]->mapi_version
, modlist
[modindex
]->name
);
758 dlclose(modlist
[modindex
]->address
);
760 rb_free(modlist
[modindex
]->name
);
761 memcpy(&modlist
[modindex
], &modlist
[modindex
+ 1],
762 sizeof(struct module) * ((num_mods
- 1) - modindex
));
769 ilog(L_MAIN
, "Module %s unloaded", name
);
770 sendto_realops_snomask(SNO_GENERAL
, L_ALL
, "Module %s unloaded", name
);
780 * inputs - path name of module, int to notice, int of core
781 * output - -1 if error 0 if success
782 * side effects - loads a module if successful
785 load_a_module(const char *path
, int warn
, int core
)
794 mod_basename
= irc_basename(path
);
796 #ifdef CHARYBDIS_PROFILE
797 tmpptr
= dlopen(path
, RTLD_NOW
| RTLD_PROFILE
);
799 tmpptr
= dlopen(path
, RTLD_NOW
);
804 const char *err
= dlerror();
806 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
807 "Error loading module %s: %s", mod_basename
, err
);
808 ilog(L_MAIN
, "Error loading module %s: %s", mod_basename
, err
);
809 rb_free(mod_basename
);
815 * _mheader is actually a struct mapi_mheader_*, but mapi_version
816 * is always the first member of this structure, so we treate it
817 * as a single int in order to determine the API version.
820 mapi_version
= (int *) (uintptr_t) dlsym(tmpptr
, "_mheader");
821 if((mapi_version
== NULL
822 && (mapi_version
= (int *) (uintptr_t) dlsym(tmpptr
, "__mheader")) == NULL
)
823 || MAPI_MAGIC(*mapi_version
) != MAPI_MAGIC_HDR
)
825 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
826 "Data format error: module %s has no MAPI header.",
828 ilog(L_MAIN
, "Data format error: module %s has no MAPI header.", mod_basename
);
829 (void) dlclose(tmpptr
);
830 rb_free(mod_basename
);
834 switch (MAPI_VERSION(*mapi_version
))
838 struct mapi_mheader_av1
*mheader
= (struct mapi_mheader_av1
*) mapi_version
; /* see above */
839 if(mheader
->mapi_register
&& (mheader
->mapi_register() == -1))
841 ilog(L_MAIN
, "Module %s indicated failure during load.",
843 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
844 "Module %s indicated failure during load.",
847 rb_free(mod_basename
);
850 if(mheader
->mapi_command_list
)
853 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
857 if(mheader
->mapi_hook_list
)
860 for (m
= mheader
->mapi_hook_list
; m
->hapi_name
; ++m
)
861 *m
->hapi_id
= register_hook(m
->hapi_name
);
864 if(mheader
->mapi_hfn_list
)
866 mapi_hfn_list_av1
*m
;
867 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
868 add_hook(m
->hapi_name
, m
->fn
);
871 ver
= mheader
->mapi_module_version
;
876 ilog(L_MAIN
, "Module %s has unknown/unsupported MAPI version %d.",
877 mod_basename
, MAPI_VERSION(*mapi_version
));
878 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
879 "Module %s has unknown/unsupported MAPI version %d.",
880 mod_basename
, *mapi_version
);
882 rb_free(mod_basename
);
891 modlist
[num_mods
] = rb_malloc(sizeof(struct module));
892 modlist
[num_mods
]->address
= tmpptr
;
893 modlist
[num_mods
]->version
= ver
;
894 modlist
[num_mods
]->core
= core
;
895 modlist
[num_mods
]->name
= rb_strdup(mod_basename
);
896 modlist
[num_mods
]->mapi_header
= mapi_version
;
897 modlist
[num_mods
]->mapi_version
= MAPI_VERSION(*mapi_version
);
902 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
903 "Module %s [version: %s; MAPI version: %d] loaded at 0x%lx",
904 mod_basename
, ver
, MAPI_VERSION(*mapi_version
),
905 (unsigned long) tmpptr
);
906 ilog(L_MAIN
, "Module %s [version: %s; MAPI version: %d] loaded at 0x%lx",
907 mod_basename
, ver
, MAPI_VERSION(*mapi_version
), (unsigned long) tmpptr
);
909 rb_free(mod_basename
);
918 * side effects - expand the size of modlist if necessary
921 increase_modlist(void)
923 struct module **new_modlist
= NULL
;
925 if((num_mods
+ 1) < max_mods
)
928 new_modlist
= (struct module **) rb_malloc(sizeof(struct module) *
929 (max_mods
+ MODS_INCREMENT
));
930 memcpy((void *) new_modlist
, (void *) modlist
, sizeof(struct module) * num_mods
);
933 modlist
= new_modlist
;
934 max_mods
+= MODS_INCREMENT
;
937 #else /* STATIC_MODULES */
939 /* load_all_modules()
943 * side effects - all the msgtabs are added for static modules
946 load_all_modules(int warn
)
948 load_static_modules();
951 #endif /* STATIC_MODULES */