2 This file is part of GNUnet.
3 Copyright (C) 2010-2014 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, 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_ats.h"
30 #include "gnunet-service-transport_plugins.h"
33 * Entry in doubly-linked list of all of our plugins.
35 struct TransportPlugin
38 * This is a doubly-linked list.
40 struct TransportPlugin *next;
43 * This is a doubly-linked list.
45 struct TransportPlugin *prev;
48 * API of the transport as returned by the plugin's
49 * initialization function.
51 struct GNUNET_TRANSPORT_PluginFunctions *api;
54 * Short name for the plugin (i.e. "tcp").
59 * Name of the library (i.e. "gnunet_plugin_transport_tcp").
64 * Environment this transport service is using
67 struct GNUNET_TRANSPORT_PluginEnvironment env;
72 * Head of DLL of all loaded plugins.
74 static struct TransportPlugin *plugins_head;
77 * Head of DLL of all loaded plugins.
79 static struct TransportPlugin *plugins_tail;
83 * Function that will be called to update metrics for an address
86 * @param address address to update metrics for
87 * @param session the session
88 * @param distance new distance
91 plugin_env_update_distance (void *cls,
92 const struct GNUNET_HELLO_Address *address,
95 GST_ats_update_distance (address,
101 * Function that will be called to figure if an address is an loopback,
102 * LAN, WAN etc. address
105 * @param addr binary address
106 * @param addrlen length of the @a addr
107 * @return type of the network @a addr belongs to
109 static enum GNUNET_ATS_Network_Type
110 plugin_env_address_to_type (void *cls,
111 const struct sockaddr *addr,
117 return GNUNET_ATS_NET_UNSPECIFIED;
119 return GNUNET_ATS_scanner_address_get_type (GST_is,
126 * Load and initialize all plugins. The respective functions will be
127 * invoked by the plugins when the respective events happen. The
128 * closure will be set to a 'const char*' containing the name of the
129 * plugin that caused the call.
131 * @param recv_cb function to call when data is received
132 * @param address_cb function to call when our public addresses changed
133 * @param session_start_cb function to call when a session was created
134 * @param session_end_cb function to call when a session was terminated
135 * @param address_type_cb function to call when a address type is requested
138 GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
139 GNUNET_TRANSPORT_AddressNotification address_cb,
140 GNUNET_TRANSPORT_SessionStart session_start_cb,
141 GNUNET_TRANSPORT_SessionEnd session_end_cb)
143 struct TransportPlugin *plug;
144 struct TransportPlugin *next;
145 unsigned long long tneigh;
152 GNUNET_CONFIGURATION_get_value_number (GST_cfg,
157 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
158 _("Transport service is lacking NEIGHBOUR_LIMIT option.\n"));
162 GNUNET_CONFIGURATION_get_value_string (GST_cfg,
167 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
168 _("Starting transport plugins `%s'\n"),
170 for (pos = strtok (plugs, " "); pos != NULL; pos = strtok (NULL, " "))
172 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
173 _("Loading `%s' transport plugin\n"),
175 GNUNET_asprintf (&libname,
176 "libgnunet_plugin_transport_%s",
178 plug = GNUNET_new (struct TransportPlugin);
179 plug->short_name = GNUNET_strdup (pos);
180 plug->lib_name = libname;
181 plug->env.cfg = GST_cfg;
182 plug->env.my_identity = &GST_my_identity;
183 plug->env.get_our_hello = &GST_hello_get;
184 plug->env.cls = plug->short_name;
185 plug->env.receive = recv_cb;
186 plug->env.notify_address = address_cb;
187 plug->env.session_start = session_start_cb;
188 plug->env.session_end = session_end_cb;
189 plug->env.get_address_type = &plugin_env_address_to_type;
190 plug->env.update_address_distance = &plugin_env_update_distance;
191 plug->env.max_connections = tneigh;
192 plug->env.stats = GST_stats;
193 GNUNET_CONTAINER_DLL_insert (plugins_head,
203 plug->api = GNUNET_PLUGIN_load (plug->lib_name,
205 if (NULL == plug->api)
207 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
208 _("Failed to load transport plugin for `%s'\n"),
210 GNUNET_CONTAINER_DLL_remove (plugins_head,
213 GNUNET_free (plug->short_name);
214 GNUNET_free (plug->lib_name);
219 if (NULL == plug->api->address_pretty_printer)
222 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
223 _("Missing function `%s' in transport plugin for `%s'\n"),
224 "address_pretty_printer",
227 if (NULL == plug->api->address_to_string)
230 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
231 _("Missing function `%s' in transport plugin for `%s'\n"),
235 if (NULL == plug->api->string_to_address)
238 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
239 _("Missing function `%s' in transport plugin for `%s'\n"),
243 if (NULL == plug->api->check_address)
246 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
247 _("Missing function `%s' in transport plugin for `%s'\n"),
251 if (NULL == plug->api->get_session)
254 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
255 _("Missing function `%s' in transport plugin for `%s'\n"),
259 if (NULL == plug->api->get_network)
262 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
263 _("Missing function `%s' in transport plugin for `%s'\n"),
267 if (NULL == plug->api->send)
270 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
271 _("Missing function `%s' in transport plugin for `%s'\n"),
275 if (NULL == plug->api->disconnect_peer)
278 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
279 _("Missing function `%s' in transport plugin for `%s'\n"),
283 if (NULL == plug->api->disconnect_session)
286 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
287 _("Missing function `%s' in transport plugin for `%s'\n"),
288 "disconnect_session",
291 if (NULL == plug->api->query_keepalive_factor)
294 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
295 _("Missing function `%s' in transport plugin for `%s'\n"),
296 "query_keepalive_factor",
299 if (NULL == plug->api->update_session_timeout)
302 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
303 _("Missing function `%s' in transport plugin for `%s'\n"),
304 "update_session_timeout",
307 if (GNUNET_YES == fail)
309 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
310 _("Did not load plugin `%s' due to missing functions\n"),
312 GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
313 GNUNET_CONTAINER_DLL_remove (plugins_head,
316 GNUNET_free (plug->short_name);
317 GNUNET_free (plug->lib_name);
328 GST_plugins_unload ()
330 struct TransportPlugin *plug;
332 while (NULL != (plug = plugins_head))
334 GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
335 GNUNET_free (plug->lib_name);
336 GNUNET_free (plug->short_name);
337 GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
344 * Obtain the plugin API based on a plugin name.
346 * @param name name of the plugin
347 * @return the plugin's API, NULL if the plugin is not loaded
349 struct GNUNET_TRANSPORT_PluginFunctions *
350 GST_plugins_find (const char *name)
352 struct TransportPlugin *pos;
354 for (pos = plugins_head; NULL != pos; pos = pos->next)
355 if (0 == strcmp (name, pos->short_name))
364 * Obtain the plugin API based on a the stripped plugin name after the underscore.
366 * Example: GST_plugins_printer_find (http_client) will return all plugins
367 * starting with the prefix "http":
368 * http_client or server if loaded
370 * @param name name of the plugin
371 * @return the plugin's API, NULL if the plugin is not loaded
373 struct GNUNET_TRANSPORT_PluginFunctions *
374 GST_plugins_printer_find (const char *name)
376 struct TransportPlugin *pos;
377 char *stripped = GNUNET_strdup (name);
378 char *sep = strchr (stripped, '_');
382 for (pos = plugins_head; NULL != pos; pos = pos->next)
383 if (pos->short_name == strstr (pos->short_name, stripped))
385 GNUNET_free (stripped);
393 * Convert a given address to a human-readable format. Note that the
394 * return value will be overwritten on the next call to this function.
396 * @param address the address to convert
397 * @return statically allocated (!) human-readable address
400 GST_plugins_a2s (const struct GNUNET_HELLO_Address *address)
402 struct GNUNET_TRANSPORT_PluginFunctions *api;
403 static char unable_to_show[1024];
404 static const char *s;
408 if (0 == address->address_length)
409 return TRANSPORT_SESSION_INBOUND_STRING; /* Addresse with length 0 are inbound, address->address itself may be NULL */
410 api = GST_plugins_printer_find (address->transport_name);
413 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
414 "Failed to find transport plugin `%s'\n",
415 address->transport_name);
416 return "<plugin unknown>";
418 if (0 == address->address_length)
420 GNUNET_snprintf (unable_to_show,
421 sizeof (unable_to_show),
422 "<unable to stringify %u-byte long address of %s transport>",
423 (unsigned int) address->address_length,
424 address->transport_name);
425 return unable_to_show;
427 return (NULL != (s = api->address_to_string (NULL,
429 address->address_length))
436 * Register callback with all plugins to monitor their status.
438 * @param cb callback to register, NULL to unsubscribe
439 * @param cb_cls closure for @a cb
442 GST_plugins_monitor_subscribe (GNUNET_TRANSPORT_SessionInfoCallback cb,
445 struct TransportPlugin *pos;
447 for (pos = plugins_head; NULL != pos; pos = pos->next)
448 if (NULL == pos->api->setup_monitor)
451 pos->api->setup_monitor (pos->api->cls,
457 /* end of file gnunet-service-transport_plugins.c */