2 This file is part of GNUnet.
3 (C) 2010,2011 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.
22 * @file transport/gnunet-service-transport_plugins.c
23 * @brief plugin management
24 * @author Christian Grothoff
27 #include "gnunet-service-transport.h"
28 #include "gnunet-service-transport_hello.h"
29 #include "gnunet-service-transport_plugins.h"
32 * Entry in doubly-linked list of all of our plugins.
34 struct TransportPlugin
37 * This is a doubly-linked list.
39 struct TransportPlugin *next;
42 * This is a doubly-linked list.
44 struct TransportPlugin *prev;
47 * API of the transport as returned by the plugin's
48 * initialization function.
50 struct GNUNET_TRANSPORT_PluginFunctions *api;
53 * Short name for the plugin (i.e. "tcp").
58 * Name of the library (i.e. "gnunet_plugin_transport_tcp").
63 * Environment this transport service is using
66 struct GNUNET_TRANSPORT_PluginEnvironment env;
71 * Head of DLL of all loaded plugins.
73 static struct TransportPlugin *plugins_head;
76 * Head of DLL of all loaded plugins.
78 static struct TransportPlugin *plugins_tail;
83 * Load and initialize all plugins. The respective functions will be
84 * invoked by the plugins when the respective events happen. The
85 * closure will be set to a 'const char*' containing the name of the
86 * plugin that caused the call.
88 * @param recv_cb function to call when data is received
89 * @param address_cb function to call when our public addresses changed
90 * @param session_start_cb function to call when a session was created
91 * @param session_end_cb function to call when a session was terminated
92 * @param address_type_cb function to call when a address type is requested
93 * @param metric_update_cb function to call when address metrics change
96 GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
97 GNUNET_TRANSPORT_AddressNotification address_cb,
98 GNUNET_TRANSPORT_SessionStart session_start_cb,
99 GNUNET_TRANSPORT_SessionEnd session_end_cb,
100 GNUNET_TRANSPORT_AddressToType address_type_cb,
101 GNUNET_TRANSPORT_UpdateAddressMetrics metric_update_cb)
103 struct TransportPlugin *plug;
104 struct TransportPlugin *next;
105 unsigned long long tneigh;
112 GNUNET_CONFIGURATION_get_value_number (GST_cfg, "TRANSPORT",
113 "NEIGHBOUR_LIMIT", &tneigh))
115 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
116 _("Transport service is lacking NEIGHBOUR_LIMIT option.\n"));
120 GNUNET_CONFIGURATION_get_value_string (GST_cfg, "TRANSPORT", "PLUGINS",
123 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
124 _("Starting transport plugins `%s'\n"),
126 for (pos = strtok (plugs, " "); pos != NULL; pos = strtok (NULL, " "))
128 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
129 _("Loading `%s' transport plugin\n"),
131 GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", pos);
132 plug = GNUNET_new (struct TransportPlugin);
133 plug->short_name = GNUNET_strdup (pos);
134 plug->lib_name = libname;
135 plug->env.cfg = GST_cfg;
136 plug->env.my_identity = &GST_my_identity;
137 plug->env.get_our_hello = &GST_hello_get;
138 plug->env.cls = plug->short_name;
139 plug->env.receive = recv_cb;
140 plug->env.notify_address = address_cb;
141 plug->env.session_start = session_start_cb;
142 plug->env.session_end = session_end_cb;
143 plug->env.get_address_type = address_type_cb;
144 plug->env.update_address_metrics = metric_update_cb;
145 plug->env.max_connections = tneigh;
146 plug->env.stats = GST_stats;
147 GNUNET_CONTAINER_DLL_insert (plugins_head, plugins_tail, plug);
155 plug->api = GNUNET_PLUGIN_load (plug->lib_name, &plug->env);
156 if (NULL == plug->api)
158 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
159 _("Failed to load transport plugin for `%s'\n"),
161 GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
162 GNUNET_free (plug->short_name);
163 GNUNET_free (plug->lib_name);
168 if (NULL == plug->api->address_pretty_printer)
171 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
172 _("Missing function `%s' in transport plugin for `%s'\n"),
173 "address_pretty_printer",
176 if (NULL == plug->api->address_to_string)
179 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
180 _("Missing function `%s' in transport plugin for `%s'\n"),
184 if (NULL == plug->api->string_to_address)
187 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
188 _("Missing function `%s' in transport plugin for `%s'\n"),
192 if (NULL == plug->api->check_address)
195 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
196 _("Missing function `%s' in transport plugin for `%s'\n"),
200 if (NULL == plug->api->get_session)
203 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
204 _("Missing function `%s' in transport plugin for `%s'\n"),
208 if (NULL == plug->api->get_network)
211 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
212 _("Missing function `%s' in transport plugin for `%s'\n"),
216 if (NULL == plug->api->send)
219 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
220 _("Missing function `%s' in transport plugin for `%s'\n"),
224 if (NULL == plug->api->disconnect_peer)
227 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
228 _("Missing function `%s' in transport plugin for `%s'\n"),
232 if (NULL == plug->api->disconnect_session)
235 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
236 _("Missing function `%s' in transport plugin for `%s'\n"),
237 "disconnect_session",
240 if (NULL == plug->api->query_keepalive_factor)
243 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
244 _("Missing function `%s' in transport plugin for `%s'\n"),
245 "query_keepalive_factor",
248 if (NULL == plug->api->update_session_timeout)
251 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
252 _("Missing function `%s' in transport plugin for `%s'\n"),
253 "update_session_timeout",
256 if (GNUNET_YES == fail)
258 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
259 _("Did not load plugin `%s' due to missing functions\n"),
261 GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
262 GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
263 GNUNET_free (plug->short_name);
264 GNUNET_free (plug->lib_name);
275 GST_plugins_unload ()
277 struct TransportPlugin *plug;
279 while (NULL != (plug = plugins_head))
281 GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
282 GNUNET_free (plug->lib_name);
283 GNUNET_free (plug->short_name);
284 GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
291 * Obtain the plugin API based on a plugin name.
293 * @param name name of the plugin
294 * @return the plugin's API, NULL if the plugin is not loaded
296 struct GNUNET_TRANSPORT_PluginFunctions *
297 GST_plugins_find (const char *name)
299 struct TransportPlugin *head = plugins_head;
301 while ((head != NULL) && (0 != strcmp (name, head->short_name)))
310 * Obtain the plugin API based on a the stripped plugin name after the underscore.
312 * Example: GST_plugins_printer_find (http_client) will return all plugins
313 * starting with the prefix "http":
314 * http_client or server if loaded
316 * @param name name of the plugin
317 * @return the plugin's API, NULL if the plugin is not loaded
319 struct GNUNET_TRANSPORT_PluginFunctions *
320 GST_plugins_printer_find (const char *name)
322 struct TransportPlugin *head = plugins_head;
324 char *stripped = GNUNET_strdup (name);
325 char *sep = strchr (stripped, '_');
331 if (head->short_name == strstr (head->short_name, stripped))
335 GNUNET_free (stripped);
343 * Convert a given address to a human-readable format. Note that the
344 * return value will be overwritten on the next call to this function.
346 * @param address the address to convert
347 * @return statically allocated (!) human-readable address
350 GST_plugins_a2s (const struct GNUNET_HELLO_Address *address)
352 struct GNUNET_TRANSPORT_PluginFunctions *api;
353 static char unable_to_show[1024];
354 static const char *s;
358 GNUNET_break (0); /* a HELLO address cannot be NULL */
361 if (0 == address->address_length)
362 return TRANSPORT_SESSION_INBOUND_STRING; /* Addresse with length 0 are inbound, address->address itself may be NULL */
363 api = GST_plugins_printer_find (address->transport_name);
365 return "<plugin unknown>";
366 if (0 == address->address_length)
368 GNUNET_snprintf (unable_to_show, sizeof (unable_to_show),
369 "<unable to stringify %u-byte long address of %s transport>",
370 (unsigned int) address->address_length,
371 address->transport_name);
372 return unable_to_show;
374 return (NULL != (s = api->address_to_string (NULL, address->address,
375 address->address_length)) ? s : "<invalid>");
379 /* end of file gnunet-service-transport_plugins.c */