2 Bacula(R) - The Network Backup Solution
4 Copyright (C) 2007-2011 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 three of the GNU Affero 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 Affero 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(R) 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 *bplugin_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));
69 static void close_plugin(Plugin *plugin)
72 Dmsg1(50, "Got plugin=%s but not accepted.\n", plugin->file);
74 if (plugin->unloadPlugin) {
75 plugin->unloadPlugin();
77 if (plugin->pHandle) {
78 dlclose(plugin->pHandle);
87 * Load all the plugins in the specified directory.
89 bool load_plugins(void *binfo, void *bfuncs, const char *plugin_dir,
90 const char *type, bool is_plugin_compatible(Plugin *plugin))
93 t_loadPlugin loadPlugin;
94 Plugin *plugin = NULL;
96 struct dirent *entry = NULL, *result;
99 POOL_MEM fname(PM_FNAME);
100 bool need_slash = false;
104 Dmsg0(dbglvl, "load_plugins\n");
105 name_max = pathconf(".", _PC_NAME_MAX);
106 if (name_max < 1024) {
110 if (!(dp = opendir(plugin_dir))) {
112 Jmsg(NULL, M_ERROR_TERM, 0, _("Failed to open Plugin directory %s: ERR=%s\n"),
113 plugin_dir, be.bstrerror());
114 Dmsg2(dbglvl, "Failed to open Plugin directory %s: ERR=%s\n",
115 plugin_dir, be.bstrerror());
119 len = strlen(plugin_dir);
121 need_slash = !IsPathSeparator(plugin_dir[len - 1]);
123 entry = (struct dirent *)malloc(sizeof(struct dirent) + name_max + 1000);
125 plugin = NULL; /* Start from a fresh plugin */
127 if ((readdir_r(dp, entry, &result) != 0) || (result == NULL)) {
129 Jmsg(NULL, M_WARNING, 0, _("Failed to find any plugins in %s\n"),
131 Dmsg1(dbglvl, "Failed to find any plugins in %s\n", plugin_dir);
135 if (strcmp(result->d_name, ".") == 0 ||
136 strcmp(result->d_name, "..") == 0) {
140 len = strlen(result->d_name);
141 type_len = strlen(type);
142 if (len < type_len+1 || strcmp(&result->d_name[len-type_len], type) != 0) {
143 Dmsg3(dbglvl, "Rejected plugin: want=%s name=%s len=%d\n", type, result->d_name, len);
146 Dmsg2(dbglvl, "Found plugin: name=%s len=%d\n", result->d_name, len);
148 pm_strcpy(fname, plugin_dir);
150 pm_strcat(fname, "/");
152 pm_strcat(fname, result->d_name);
153 if (lstat(fname.c_str(), &statp) != 0 || !S_ISREG(statp.st_mode)) {
154 continue; /* ignore directories & special files */
157 plugin = new_plugin();
158 plugin->file = bstrdup(result->d_name);
159 plugin->file_len = strstr(plugin->file, type) - plugin->file;
160 plugin->pHandle = dlopen(fname.c_str(), RTLD_NOW);
161 if (!plugin->pHandle) {
162 char *error = (char *)dlerror();
163 Jmsg(NULL, M_ERROR, 0, _("dlopen plugin %s failed: ERR=%s\n"),
164 fname.c_str(), NPRT(error));
165 Dmsg2(dbglvl, "dlopen plugin %s failed: ERR=%s\n", fname.c_str(),
167 close_plugin(plugin);
171 /* Get two global entry points */
172 loadPlugin = (t_loadPlugin)dlsym(plugin->pHandle, "loadPlugin");
174 Jmsg(NULL, M_ERROR, 0, _("Lookup of loadPlugin in plugin %s failed: ERR=%s\n"),
175 fname.c_str(), NPRT(dlerror()));
176 Dmsg2(dbglvl, "Lookup of loadPlugin in plugin %s failed: ERR=%s\n",
177 fname.c_str(), NPRT(dlerror()));
178 close_plugin(plugin);
181 plugin->unloadPlugin = (t_unloadPlugin)dlsym(plugin->pHandle, "unloadPlugin");
182 if (!plugin->unloadPlugin) {
183 Jmsg(NULL, M_ERROR, 0, _("Lookup of unloadPlugin in plugin %s failed: ERR=%s\n"),
184 fname.c_str(), NPRT(dlerror()));
185 Dmsg2(dbglvl, "Lookup of unloadPlugin in plugin %s failed: ERR=%s\n",
186 fname.c_str(), NPRT(dlerror()));
187 close_plugin(plugin);
191 /* Initialize the plugin */
192 if (loadPlugin(binfo, bfuncs, &plugin->pinfo, &plugin->pfuncs) != bRC_OK) {
193 close_plugin(plugin);
196 if (!is_plugin_compatible) {
197 Dmsg0(50, "Plugin compatibility pointer not set.\n");
198 } else if (!is_plugin_compatible(plugin)) {
199 close_plugin(plugin);
203 found = true; /* found a plugin */
204 bplugin_list->append(plugin);
208 if (!found && plugin) {
209 close_plugin(plugin);
221 * Unload all the loaded plugins
223 void unload_plugins()
230 foreach_alist(plugin, bplugin_list) {
231 /* Shut it down and unload it */
232 plugin->unloadPlugin();
233 dlclose(plugin->pHandle);
244 * Dump plugin information
245 * Each daemon can register a hook that will be called
246 * after a fatal signal.
248 #define DBG_MAX_HOOK 10
249 static dbg_plugin_hook_t *dbg_plugin_hooks[DBG_MAX_HOOK];
250 static int dbg_plugin_hook_count=0;
252 void dbg_plugin_add_hook(dbg_plugin_hook_t *fct)
254 ASSERT(dbg_plugin_hook_count < DBG_MAX_HOOK);
255 dbg_plugin_hooks[dbg_plugin_hook_count++] = fct;
258 void dbg_print_plugin(FILE *fp)
261 fprintf(fp, "Attempt to dump plugins. Hook count=%d\n", dbg_plugin_hook_count);
266 foreach_alist(plugin, bplugin_list) {
267 for(int i=0; i < dbg_plugin_hook_count; i++) {
268 // dbg_plugin_hook_t *fct = dbg_plugin_hooks[i];
269 fprintf(fp, "Plugin %p name=\"%s\" disabled=%d\n",
270 plugin, plugin->file, plugin->disabled);