2 This file is part of GNUnet.
3 Copyright (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;
82 * Load and initialize all plugins. The respective functions will be
83 * invoked by the plugins when the respective events happen. The
84 * closure will be set to a 'const char*' containing the name of the
85 * plugin that caused the call.
87 * @param recv_cb function to call when data is received
88 * @param address_cb function to call when our public addresses changed
89 * @param session_start_cb function to call when a session was created
90 * @param session_end_cb function to call when a session was terminated
91 * @param address_type_cb function to call when a address type is requested
92 * @param metric_update_cb function to call when address metrics change
95 GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
96 GNUNET_TRANSPORT_AddressNotification address_cb,
97 GNUNET_TRANSPORT_SessionStart session_start_cb,
98 GNUNET_TRANSPORT_SessionEnd session_end_cb,
99 GNUNET_TRANSPORT_AddressToType address_type_cb,
100 GNUNET_TRANSPORT_UpdateAddressMetrics metric_update_cb)
102 struct TransportPlugin *plug;
103 struct TransportPlugin *next;
104 unsigned long long tneigh;
111 GNUNET_CONFIGURATION_get_value_number (GST_cfg, "TRANSPORT",
112 "NEIGHBOUR_LIMIT", &tneigh))
114 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
115 _("Transport service is lacking NEIGHBOUR_LIMIT option.\n"));
119 GNUNET_CONFIGURATION_get_value_string (GST_cfg, "TRANSPORT", "PLUGINS",
122 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
123 _("Starting transport plugins `%s'\n"),
125 for (pos = strtok (plugs, " "); pos != NULL; pos = strtok (NULL, " "))
127 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
128 _("Loading `%s' transport plugin\n"),
130 GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", pos);
131 plug = GNUNET_new (struct TransportPlugin);
132 plug->short_name = GNUNET_strdup (pos);
133 plug->lib_name = libname;
134 plug->env.cfg = GST_cfg;
135 plug->env.my_identity = &GST_my_identity;
136 plug->env.get_our_hello = &GST_hello_get;
137 plug->env.cls = plug->short_name;
138 plug->env.receive = recv_cb;
139 plug->env.notify_address = address_cb;
140 plug->env.session_start = session_start_cb;
141 plug->env.session_end = session_end_cb;
142 plug->env.get_address_type = address_type_cb;
143 plug->env.update_address_metrics = metric_update_cb;
144 plug->env.max_connections = tneigh;
145 plug->env.stats = GST_stats;
146 GNUNET_CONTAINER_DLL_insert (plugins_head, plugins_tail, plug);
154 plug->api = GNUNET_PLUGIN_load (plug->lib_name, &plug->env);
155 if (NULL == plug->api)
157 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
158 _("Failed to load transport plugin for `%s'\n"),
160 GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
161 GNUNET_free (plug->short_name);
162 GNUNET_free (plug->lib_name);
167 if (NULL == plug->api->address_pretty_printer)
170 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
171 _("Missing function `%s' in transport plugin for `%s'\n"),
172 "address_pretty_printer",
175 if (NULL == plug->api->address_to_string)
178 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
179 _("Missing function `%s' in transport plugin for `%s'\n"),
183 if (NULL == plug->api->string_to_address)
186 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
187 _("Missing function `%s' in transport plugin for `%s'\n"),
191 if (NULL == plug->api->check_address)
194 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
195 _("Missing function `%s' in transport plugin for `%s'\n"),
199 if (NULL == plug->api->get_session)
202 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
203 _("Missing function `%s' in transport plugin for `%s'\n"),
207 if (NULL == plug->api->get_network)
210 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
211 _("Missing function `%s' in transport plugin for `%s'\n"),
215 if (NULL == plug->api->send)
218 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
219 _("Missing function `%s' in transport plugin for `%s'\n"),
223 if (NULL == plug->api->disconnect_peer)
226 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
227 _("Missing function `%s' in transport plugin for `%s'\n"),
231 if (NULL == plug->api->disconnect_session)
234 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
235 _("Missing function `%s' in transport plugin for `%s'\n"),
236 "disconnect_session",
239 if (NULL == plug->api->query_keepalive_factor)
242 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
243 _("Missing function `%s' in transport plugin for `%s'\n"),
244 "query_keepalive_factor",
247 if (NULL == plug->api->update_session_timeout)
250 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
251 _("Missing function `%s' in transport plugin for `%s'\n"),
252 "update_session_timeout",
255 if (GNUNET_YES == fail)
257 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
258 _("Did not load plugin `%s' due to missing functions\n"),
260 GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
261 GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
262 GNUNET_free (plug->short_name);
263 GNUNET_free (plug->lib_name);
274 GST_plugins_unload ()
276 struct TransportPlugin *plug;
278 while (NULL != (plug = plugins_head))
280 GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
281 GNUNET_free (plug->lib_name);
282 GNUNET_free (plug->short_name);
283 GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
290 * Obtain the plugin API based on a plugin name.
292 * @param name name of the plugin
293 * @return the plugin's API, NULL if the plugin is not loaded
295 struct GNUNET_TRANSPORT_PluginFunctions *
296 GST_plugins_find (const char *name)
298 struct TransportPlugin *pos;
300 for (pos = plugins_head; NULL != pos; pos = pos->next)
301 if (0 == strcmp (name, pos->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 *pos;
323 char *stripped = GNUNET_strdup (name);
324 char *sep = strchr (stripped, '_');
328 for (pos = plugins_head; NULL != pos; pos = pos->next)
329 if (pos->short_name == strstr (pos->short_name, stripped))
331 GNUNET_free (stripped);
339 * Convert a given address to a human-readable format. Note that the
340 * return value will be overwritten on the next call to this function.
342 * @param address the address to convert
343 * @return statically allocated (!) human-readable address
346 GST_plugins_a2s (const struct GNUNET_HELLO_Address *address)
348 struct GNUNET_TRANSPORT_PluginFunctions *api;
349 static char unable_to_show[1024];
350 static const char *s;
354 if (0 == address->address_length)
355 return TRANSPORT_SESSION_INBOUND_STRING; /* Addresse with length 0 are inbound, address->address itself may be NULL */
356 api = GST_plugins_printer_find (address->transport_name);
358 return "<plugin unknown>";
359 if (0 == address->address_length)
361 GNUNET_snprintf (unable_to_show, sizeof (unable_to_show),
362 "<unable to stringify %u-byte long address of %s transport>",
363 (unsigned int) address->address_length,
364 address->transport_name);
365 return unable_to_show;
367 return (NULL != (s = api->address_to_string (NULL, address->address,
368 address->address_length)) ? s : "<invalid>");
373 * Register callback with all plugins to monitor their status.
375 * @param cb callback to register, NULL to unsubscribe
376 * @param cb_cls closure for @a cb
379 GST_plugins_monitor_subscribe (GNUNET_TRANSPORT_SessionInfoCallback cb,
382 struct TransportPlugin *pos;
384 for (pos = plugins_head; NULL != pos; pos = pos->next)
385 if (NULL == pos->api->setup_monitor)
388 pos->api->setup_monitor (pos->api->cls,
393 /* end of file gnunet-service-transport_plugins.c */