2 This file is part of GNUnet.
3 (C) 2010-2014 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 register_quota_cb function to call to register a quota callback
90 * @param unregister_quota_cb function to call to unregister a quota callback
91 * @param address_cb function to call when our public addresses changed
92 * @param session_start_cb function to call when a session was created
93 * @param session_end_cb function to call when a session was terminated
94 * @param address_type_cb function to call when a address type is requested
95 * @param metric_update_cb function to call when address metrics change
98 GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
99 GNUNET_TRANSPORT_RegisterQuotaNotification register_quota_cb,
100 GNUNET_TRANSPORT_UnregisterQuotaNotification unregister_quota_cb,
101 GNUNET_TRANSPORT_AddressNotification address_cb,
102 GNUNET_TRANSPORT_SessionStart session_start_cb,
103 GNUNET_TRANSPORT_SessionEnd session_end_cb,
104 GNUNET_TRANSPORT_AddressToType address_type_cb,
105 GNUNET_TRANSPORT_UpdateAddressMetrics metric_update_cb)
107 struct TransportPlugin *plug;
108 struct TransportPlugin *next;
109 unsigned long long tneigh;
116 GNUNET_CONFIGURATION_get_value_number (GST_cfg, "TRANSPORT",
117 "NEIGHBOUR_LIMIT", &tneigh))
119 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
120 _("Transport service is lacking NEIGHBOUR_LIMIT option.\n"));
124 GNUNET_CONFIGURATION_get_value_string (GST_cfg, "TRANSPORT", "PLUGINS",
127 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
128 _("Starting transport plugins `%s'\n"),
130 for (pos = strtok (plugs, " "); pos != NULL; pos = strtok (NULL, " "))
132 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
133 _("Loading `%s' transport plugin\n"),
135 GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", pos);
136 plug = GNUNET_new (struct TransportPlugin);
137 plug->short_name = GNUNET_strdup (pos);
138 plug->lib_name = libname;
139 plug->env.cfg = GST_cfg;
140 plug->env.my_identity = &GST_my_identity;
141 plug->env.get_our_hello = &GST_hello_get;
142 plug->env.cls = plug->short_name;
143 plug->env.receive = recv_cb;
144 plug->env.notify_address = address_cb;
145 plug->env.session_start = session_start_cb;
146 plug->env.session_end = session_end_cb;
147 plug->env.get_address_type = address_type_cb;
148 plug->env.update_address_metrics = metric_update_cb;
149 plug->env.register_quota_notification = register_quota_cb;
150 plug->env.unregister_quota_notification = unregister_quota_cb;
151 plug->env.max_connections = tneigh;
152 plug->env.stats = GST_stats;
153 GNUNET_CONTAINER_DLL_insert (plugins_head, plugins_tail, plug);
161 plug->api = GNUNET_PLUGIN_load (plug->lib_name, &plug->env);
162 if (NULL == plug->api)
164 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
165 _("Failed to load transport plugin for `%s'\n"),
167 GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
168 GNUNET_free (plug->short_name);
169 GNUNET_free (plug->lib_name);
174 if (NULL == plug->api->address_pretty_printer)
177 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
178 _("Missing function `%s' in transport plugin for `%s'\n"),
179 "address_pretty_printer",
182 if (NULL == plug->api->address_to_string)
185 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
186 _("Missing function `%s' in transport plugin for `%s'\n"),
190 if (NULL == plug->api->string_to_address)
193 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
194 _("Missing function `%s' in transport plugin for `%s'\n"),
198 if (NULL == plug->api->check_address)
201 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
202 _("Missing function `%s' in transport plugin for `%s'\n"),
206 if (NULL == plug->api->get_session)
209 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
210 _("Missing function `%s' in transport plugin for `%s'\n"),
214 if (NULL == plug->api->get_network)
217 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
218 _("Missing function `%s' in transport plugin for `%s'\n"),
222 if (NULL == plug->api->send)
225 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
226 _("Missing function `%s' in transport plugin for `%s'\n"),
230 if (NULL == plug->api->disconnect_peer)
233 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
234 _("Missing function `%s' in transport plugin for `%s'\n"),
238 if (NULL == plug->api->disconnect_session)
241 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
242 _("Missing function `%s' in transport plugin for `%s'\n"),
243 "disconnect_session",
246 if (NULL == plug->api->query_keepalive_factor)
249 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
250 _("Missing function `%s' in transport plugin for `%s'\n"),
251 "query_keepalive_factor",
254 if (NULL == plug->api->update_session_timeout)
257 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
258 _("Missing function `%s' in transport plugin for `%s'\n"),
259 "update_session_timeout",
262 if (GNUNET_YES == fail)
264 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
265 _("Did not load plugin `%s' due to missing functions\n"),
267 GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
268 GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
269 GNUNET_free (plug->short_name);
270 GNUNET_free (plug->lib_name);
281 GST_plugins_unload ()
283 struct TransportPlugin *plug;
285 while (NULL != (plug = plugins_head))
287 GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
288 GNUNET_free (plug->lib_name);
289 GNUNET_free (plug->short_name);
290 GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
297 * Obtain the plugin API based on a plugin name.
299 * @param name name of the plugin
300 * @return the plugin's API, NULL if the plugin is not loaded
302 struct GNUNET_TRANSPORT_PluginFunctions *
303 GST_plugins_find (const char *name)
305 struct TransportPlugin *pos;
307 for (pos = plugins_head; NULL != pos; pos = pos->next)
308 if (0 == strcmp (name, pos->short_name))
317 * Obtain the plugin API based on a the stripped plugin name after the underscore.
319 * Example: GST_plugins_printer_find (http_client) will return all plugins
320 * starting with the prefix "http":
321 * http_client or server if loaded
323 * @param name name of the plugin
324 * @return the plugin's API, NULL if the plugin is not loaded
326 struct GNUNET_TRANSPORT_PluginFunctions *
327 GST_plugins_printer_find (const char *name)
329 struct TransportPlugin *pos;
330 char *stripped = GNUNET_strdup (name);
331 char *sep = strchr (stripped, '_');
335 for (pos = plugins_head; NULL != pos; pos = pos->next)
336 if (pos->short_name == strstr (pos->short_name, stripped))
338 GNUNET_free (stripped);
346 * Convert a given address to a human-readable format. Note that the
347 * return value will be overwritten on the next call to this function.
349 * @param address the address to convert
350 * @return statically allocated (!) human-readable address
353 GST_plugins_a2s (const struct GNUNET_HELLO_Address *address)
355 struct GNUNET_TRANSPORT_PluginFunctions *api;
356 static char unable_to_show[1024];
357 static const char *s;
361 GNUNET_break (0); /* a HELLO address cannot be NULL */
364 if (0 == address->address_length)
365 return TRANSPORT_SESSION_INBOUND_STRING; /* Addresse with length 0 are inbound, address->address itself may be NULL */
366 api = GST_plugins_printer_find (address->transport_name);
368 return "<plugin unknown>";
369 if (0 == address->address_length)
371 GNUNET_snprintf (unable_to_show, sizeof (unable_to_show),
372 "<unable to stringify %u-byte long address of %s transport>",
373 (unsigned int) address->address_length,
374 address->transport_name);
375 return unable_to_show;
377 return (NULL != (s = api->address_to_string (NULL, address->address,
378 address->address_length)) ? s : "<invalid>");
383 * Register callback with all plugins to monitor their status.
385 * @param cb callback to register, NULL to unsubscribe
386 * @param cb_cls closure for @a cb
389 GST_plugins_monitor_subscribe (GNUNET_TRANSPORT_SessionInfoCallback cb,
392 struct TransportPlugin *pos;
394 for (pos = plugins_head; NULL != pos; pos = pos->next)
395 if (NULL == pos->api->setup_monitor)
398 pos->api->setup_monitor (pos->api->cls,
403 /* end of file gnunet-service-transport_plugins.c */