2 This file is part of GNUnet
3 (C) 2002, 2003, 2004, 2005, 2006, 2009 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
23 * @brief Methods to access plugins
24 * @author Christian Grothoff
29 #include "gnunet_util_lib.h"
31 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
34 * Linked list of active plugins.
39 * This is a linked list.
41 struct PluginList *next;
44 * Name of the library.
56 * Have we been initialized?
58 static int initialized;
62 * Libtool search path before we started.
64 static char *old_dlsearchpath;
68 * List of plugins we have loaded.
70 static struct PluginList *plugins;
74 * Setup libtool paths.
87 FPRINTF (stderr, _("Initialization of plugin mechanism failed: %s!\n"),
91 opath = lt_dlgetsearchpath ();
93 old_dlsearchpath = GNUNET_strdup (opath);
94 path = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LIBDIR);
99 GNUNET_asprintf (&cpath, "%s:%s", opath, path);
100 lt_dlsetsearchpath (cpath);
106 lt_dlsetsearchpath (path);
119 lt_dlsetsearchpath (old_dlsearchpath);
120 if (old_dlsearchpath != NULL)
122 GNUNET_free (old_dlsearchpath);
123 old_dlsearchpath = NULL;
130 * Lookup a function in the plugin.
132 static GNUNET_PLUGIN_Callback
133 resolve_function (struct PluginList *plug, const char *name)
138 GNUNET_asprintf (&initName, "_%s_%s", plug->name, name);
139 mptr = lt_dlsym (plug->handle, &initName[1]);
141 mptr = lt_dlsym (plug->handle, initName);
143 LOG (GNUNET_ERROR_TYPE_ERROR,
144 _("`%s' failed to resolve method '%s' with error: %s\n"), "lt_dlsym",
145 &initName[1], lt_dlerror ());
146 GNUNET_free (initName);
151 * Test if a plugin exists.
153 * Note that the library must export a symbol called
154 * "library_name_init" for the test to succeed.
156 * @param library_name name of the plugin to test if it is installed
157 * @return GNUNET_YES if the plugin exists, GNUNET_NO if not
160 GNUNET_PLUGIN_test (const char *library_name)
163 GNUNET_PLUGIN_Callback init;
164 struct PluginList plug;
168 initialized = GNUNET_YES;
171 libhandle = lt_dlopenext (library_name);
172 if (libhandle == NULL)
174 plug.handle = libhandle;
175 plug.name = (char *) library_name;
176 init = resolve_function (&plug, "init");
180 lt_dlclose (libhandle);
183 lt_dlclose (libhandle);
189 * Setup plugin (runs the "init" callback and returns whatever "init"
190 * returned). If "init" returns NULL, the plugin is unloaded.
192 * Note that the library must export symbols called
193 * "library_name_init" and "library_name_done". These will be called
194 * when the library is loaded and unloaded respectively.
196 * @param library_name name of the plugin to load
197 * @param arg argument to the plugin initialization function
198 * @return whatever the initialization function returned
201 GNUNET_PLUGIN_load (const char *library_name, void *arg)
204 struct PluginList *plug;
205 GNUNET_PLUGIN_Callback init;
210 initialized = GNUNET_YES;
213 libhandle = lt_dlopenext (library_name);
214 if (libhandle == NULL)
216 LOG (GNUNET_ERROR_TYPE_ERROR,
217 _("`%s' failed for library `%s' with error: %s\n"), "lt_dlopenext",
218 library_name, lt_dlerror ());
221 plug = GNUNET_malloc (sizeof (struct PluginList));
222 plug->handle = libhandle;
223 plug->name = GNUNET_strdup (library_name);
224 plug->next = plugins;
226 init = resolve_function (plug, "init");
227 if ((init == NULL) || (NULL == (ret = init (arg))))
229 lt_dlclose (libhandle);
230 GNUNET_free (plug->name);
231 plugins = plug->next;
240 * Unload plugin (runs the "done" callback and returns whatever "done"
241 * returned). The plugin is then unloaded.
243 * @param library_name name of the plugin to unload
244 * @param arg argument to the plugin shutdown function
245 * @return whatever the shutdown function returned
248 GNUNET_PLUGIN_unload (const char *library_name, void *arg)
250 struct PluginList *pos;
251 struct PluginList *prev;
252 GNUNET_PLUGIN_Callback done;
257 while ((pos != NULL) && (0 != strcmp (pos->name, library_name)))
265 done = resolve_function (pos, "done");
272 prev->next = pos->next;
273 lt_dlclose (pos->handle);
274 GNUNET_free (pos->name);
279 initialized = GNUNET_NO;
285 struct LoadAllContext
287 const char *basename;
289 GNUNET_PLUGIN_LoaderCallback cb;
295 find_libraries (void *cls, const char *filename)
297 struct LoadAllContext *lac = cls;
298 const char *slashpos;
306 while (NULL != (slashpos = strstr (libname, DIR_SEPARATOR_STR)))
307 libname = slashpos + 1;
308 n = strlen (libname);
309 if (0 != strncmp (lac->basename, libname, strlen (lac->basename)))
310 return GNUNET_OK; /* wrong name */
311 if ((n > 3) && (0 == strcmp (&libname[n - 3], ".la")))
312 return GNUNET_OK; /* .la file */
313 basename = GNUNET_strdup (libname);
314 if (NULL != (dot = strstr (basename, ".")))
316 lib_ret = GNUNET_PLUGIN_load (basename, lac->arg);
318 lac->cb (lac->cb_cls, basename, lib_ret);
319 GNUNET_free (basename);
325 * Load all compatible plugins with the given base name.
327 * Note that the library must export symbols called
328 * "basename_ANYTHING_init" and "basename_ANYTHING__done". These will
329 * be called when the library is loaded and unloaded respectively.
331 * @param basename basename of the plugins to load
332 * @param arg argument to the plugin initialization function
333 * @param cb function to call for each plugin found
334 * @param cb_cls closure for 'cb'
337 GNUNET_PLUGIN_load_all (const char *basename, void *arg,
338 GNUNET_PLUGIN_LoaderCallback cb, void *cb_cls)
340 struct LoadAllContext lac;
343 path = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LIBDIR);
346 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
347 _("Could not determine plugin installation path.\n"));
350 lac.basename = basename;
354 GNUNET_DISK_directory_scan (path, &find_libraries, &lac);
359 /* end of plugin.c */