2 Bacula® - The Network Backup Solution
4 Copyright (C) 2007-2008 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation, which is
11 listed in the file LICENSE.
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
29 * Plugin load/unloader for all Bacula daemons
31 * Kern Sibbald, October 2007
38 #define NAMELEN(dirent) (strlen((dirent)->d_name))
40 #ifndef HAVE_READDIR_R
41 int readdir_r(DIR *dirp, struct dirent *entry, struct dirent **result);
50 static const int dbglvl = 50;
52 /* All loaded plugins */
53 alist *plugin_list = NULL;
56 * Create a new plugin "class" entry and enter it in the
57 * list of plugins. Note, this is not the same as
58 * an instance of the plugin.
64 plugin = (Plugin *)malloc(sizeof(Plugin));
65 memset(plugin, 0, sizeof(Plugin));
71 * Load all the plugins in the specified directory.
73 bool load_plugins(void *binfo, void *bfuncs, const char *plugin_dir, const char *type)
76 t_loadPlugin loadPlugin;
77 Plugin *plugin = NULL;
79 struct dirent *entry = NULL, *result;
82 POOL_MEM fname(PM_FNAME);
83 bool need_slash = false;
87 name_max = pathconf(".", _PC_NAME_MAX);
88 if (name_max < 1024) {
92 if (!(dp = opendir(plugin_dir))) {
94 Jmsg(NULL, M_ERROR_TERM, 0, _("Failed to open Plugin directory %s: ERR=%s\n"),
95 plugin_dir, be.bstrerror());
96 Dmsg2(dbglvl, "Failed to open Plugin directory %s: ERR=%s\n",
97 plugin_dir, be.bstrerror());
101 len = strlen(plugin_dir);
103 need_slash = !IsPathSeparator(plugin_dir[len - 1]);
105 entry = (struct dirent *)malloc(sizeof(struct dirent) + name_max + 1000);
107 if ((readdir_r(dp, entry, &result) != 0) || (result == NULL)) {
109 Jmsg(NULL, M_WARNING, 0, _("Failed to find any plugins in %s\n"),
111 Dmsg1(dbglvl, "Failed to find any plugins in %s\n", plugin_dir);
115 if (strcmp(result->d_name, ".") == 0 ||
116 strcmp(result->d_name, "..") == 0) {
120 len = strlen(result->d_name);
121 type_len = strlen(type);
122 if (len < type_len+1 || strcmp(&result->d_name[len-type_len], type) != 0) {
123 Dmsg3(dbglvl, "Rejected plugin: want=%s name=%s len=%d\n", type, result->d_name, len);
126 Dmsg2(dbglvl, "Loaded plugin: name=%s len=%d\n", result->d_name, len);
128 pm_strcpy(fname, plugin_dir);
130 pm_strcat(fname, "/");
132 pm_strcat(fname, result->d_name);
133 if (lstat(fname.c_str(), &statp) != 0 || !S_ISREG(statp.st_mode)) {
134 continue; /* ignore directories & special files */
137 plugin = new_plugin();
138 plugin->file = bstrdup(result->d_name);
139 plugin->pHandle = dlopen(fname.c_str(), RTLD_NOW);
140 if (!plugin->pHandle) {
141 Jmsg(NULL, M_ERROR, 0, _("Plugin load %s failed: ERR=%s\n"),
142 fname.c_str(), NPRT(dlerror()));
143 Dmsg2(dbglvl, "Plugin load %s failed: ERR=%s\n", fname.c_str(),
148 /* Get two global entry points */
149 loadPlugin = (t_loadPlugin)dlsym(plugin->pHandle, "loadPlugin");
151 Jmsg(NULL, M_ERROR, 0, _("Lookup of loadPlugin in plugin %s failed: ERR=%s\n"),
152 fname.c_str(), NPRT(dlerror()));
153 Dmsg2(dbglvl, "Lookup of loadPlugin in plugin %s failed: ERR=%s\n",
154 fname.c_str(), NPRT(dlerror()));
157 plugin->unloadPlugin = (t_unloadPlugin)dlsym(plugin->pHandle, "unloadPlugin");
158 if (!plugin->unloadPlugin) {
159 Jmsg(NULL, M_ERROR, 0, _("Lookup of unloadPlugin in plugin %s failed: ERR=%s\n"),
160 fname.c_str(), NPRT(dlerror()));
161 Dmsg2(dbglvl, "Lookup of unloadPlugin in plugin %s failed: ERR=%s\n",
162 fname.c_str(), NPRT(dlerror()));
166 /* Initialize the plugin */
167 if (loadPlugin(binfo, bfuncs, &plugin->pinfo, &plugin->pfuncs) != bRC_OK) {
171 found = true; /* found a plugin */
172 plugin_list->append(plugin);
176 if (!found && plugin) {
189 * Unload all the loaded plugins
191 void unload_plugins()
198 foreach_alist(plugin, plugin_list) {
199 /* Shut it down and unload it */
200 plugin->unloadPlugin();
201 dlclose(plugin->pHandle);
212 * Dump plugin information
213 * Each daemon can register a hook that will be called
214 * after a fatal signal.
216 #define DBG_MAX_HOOK 10
217 static dbg_plugin_hook_t *dbg_plugin_hooks[DBG_MAX_HOOK];
218 static int dbg_plugin_hook_count=0;
220 void dbg_plugin_add_hook(dbg_plugin_hook_t *fct)
222 ASSERT(dbg_plugin_hook_count < DBG_MAX_HOOK);
223 dbg_plugin_hooks[dbg_plugin_hook_count++] = fct;
226 void _dbg_print_plugin(FILE *fp)
229 fprintf(fp, "Attempt to dump plugins\n");
235 foreach_alist(plugin, plugin_list) {
236 for(int i=0; i < dbg_plugin_hook_count; i++) {
237 dbg_plugin_hook_t *fct = dbg_plugin_hooks[i];
238 fprintf(fp, "Plugin %p name=\"%s\" disabled=%d\n",
239 plugin, plugin->file, plugin->disabled);