src/transport/gnunet-service-transport_plugins.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010,2011 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file transport/gnunet-service-transport_plugins.c
  23  * @brief plugin management
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet-service-transport.h"
  28 #include "gnunet-service-transport_hello.h"
  29 #include "gnunet-service-transport_plugins.h"
  30
  31 /**
  32  * Entry in doubly-linked list of all of our plugins.
  33  */
  34 struct TransportPlugin
  35 {
  36   /**
  37    * This is a doubly-linked list.
  38    */
  39   struct TransportPlugin *next;
  40
  41   /**
  42    * This is a doubly-linked list.
  43    */
  44   struct TransportPlugin *prev;
  45
  46   /**
  47    * API of the transport as returned by the plugin's
  48    * initialization function.
  49    */
  50   struct GNUNET_TRANSPORT_PluginFunctions *api;
  51
  52   /**
  53    * Short name for the plugin (i.e. "tcp").
  54    */
  55   char *short_name;
  56
  57   /**
  58    * Name of the library (i.e. "gnunet_plugin_transport_tcp").
  59    */
  60   char *lib_name;
  61
  62   /**
  63    * Environment this transport service is using
  64    * for this plugin.
  65    */
  66   struct GNUNET_TRANSPORT_PluginEnvironment env;
  67
  68 };
  69
  70 /**
  71  * Head of DLL of all loaded plugins.
  72  */
  73 static struct TransportPlugin *plugins_head;
  74
  75 /**
  76  * Head of DLL of all loaded plugins.
  77  */
  78 static struct TransportPlugin *plugins_tail;
  79
  80
  81
  82 /**
  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.
  87  *
  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_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
  93  */
  94 void
  95 GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
  96                   GNUNET_TRANSPORT_AddressNotification address_cb,
  97                   GNUNET_TRANSPORT_SessionEnd session_end_cb,
  98                   GNUNET_TRANSPORT_AddressToType address_type_cb,
  99                   GNUNET_TRANSPORT_UpdateAddressMetrics metric_update_cb)
 100 {
 101   struct TransportPlugin *plug;
 102   struct TransportPlugin *next;
 103   unsigned long long tneigh;
 104   char *libname;
 105   char *plugs;
 106   char *pos;
 107
 108   if (GNUNET_OK !=
 109       GNUNET_CONFIGURATION_get_value_number (GST_cfg, "TRANSPORT",
 110                                              "NEIGHBOUR_LIMIT", &tneigh))
 111   {
 112     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 113                 _("Transport service is lacking NEIGHBOUR_LIMIT option.\n"));
 114     return;
 115   }
 116   if (GNUNET_OK !=
 117       GNUNET_CONFIGURATION_get_value_string (GST_cfg, "TRANSPORT", "PLUGINS",
 118                                              &plugs))
 119     return;
 120   GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Starting transport plugins `%s'\n"),
 121               plugs);
 122   for (pos = strtok (plugs, " "); pos != NULL; pos = strtok (NULL, " "))
 123   {
 124     GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Loading `%s' transport plugin\n"),
 125                 pos);
 126     GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", pos);
 127     plug = GNUNET_malloc (sizeof (struct TransportPlugin));
 128     plug->short_name = GNUNET_strdup (pos);
 129     plug->lib_name = libname;
 130     plug->env.cfg = GST_cfg;
 131     plug->env.my_identity = &GST_my_identity;
 132     plug->env.get_our_hello = &GST_hello_get;
 133     plug->env.cls = plug->short_name;
 134     plug->env.receive = recv_cb;
 135     plug->env.notify_address = address_cb;
 136     plug->env.session_end = session_end_cb;
 137     plug->env.get_address_type = address_type_cb;
 138     plug->env.update_address_metrics = metric_update_cb;
 139     plug->env.max_connections = tneigh;
 140     plug->env.stats = GST_stats;
 141     GNUNET_CONTAINER_DLL_insert (plugins_head, plugins_tail, plug);
 142   }
 143   GNUNET_free (plugs);
 144   next = plugins_head;
 145   while (next != NULL)
 146   {
 147     plug = next;
 148     next = plug->next;
 149     plug->api = GNUNET_PLUGIN_load (plug->lib_name, &plug->env);
 150     if (plug->api == NULL)
 151     {
 152       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 153                   _("Failed to load transport plugin for `%s'\n"),
 154                   plug->lib_name);
 155       GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
 156       GNUNET_free (plug->short_name);
 157       GNUNET_free (plug->lib_name);
 158       GNUNET_free (plug);
 159     }
 160   }
 161 }
 162
 163
 164 /**
 165  * Unload all plugins
 166  */
 167 void
 168 GST_plugins_unload ()
 169 {
 170   struct TransportPlugin *plug;
 171
 172   while (NULL != (plug = plugins_head))
 173   {
 174     GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
 175     GNUNET_free (plug->lib_name);
 176     GNUNET_free (plug->short_name);
 177     GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
 178     GNUNET_free (plug);
 179   }
 180 }
 181
 182
 183 /**
 184  * Obtain the plugin API based on a plugin name.
 185  *
 186  * @param name name of the plugin
 187  * @return the plugin's API, NULL if the plugin is not loaded
 188  */
 189 struct GNUNET_TRANSPORT_PluginFunctions *
 190 GST_plugins_find (const char *name)
 191 {
 192   struct TransportPlugin *head = plugins_head;
 193
 194   while ((head != NULL) && (0 != strcmp (name, head->short_name)))
 195     head = head->next;
 196   if (NULL == head)
 197     return NULL;
 198   return head->api;
 199 }
 200
 201
 202 /**
 203  * Obtain the plugin API based on a the stripped plugin name after the underscore.
 204  *
 205  * Example: GST_plugins_printer_find (http_client) will return all plugins
 206  * starting with the prefix "http":
 207  * http_client or server if loaded
 208  *
 209  * @param name name of the plugin
 210  * @return the plugin's API, NULL if the plugin is not loaded
 211  */
 212 struct GNUNET_TRANSPORT_PluginFunctions *
 213 GST_plugins_printer_find (const char *name)
 214 {
 215   struct TransportPlugin *head = plugins_head;
 216
 217   char *stripped = GNUNET_strdup (name);
 218   char *sep = strchr (stripped, '_');
 219   if (NULL != sep)
 220     sep[0] = '\0';
 221
 222   while (head != NULL)
 223   {
 224     if (head->short_name == strstr (head->short_name, stripped))
 225         break;
 226     head = head->next;
 227   }
 228   GNUNET_free (stripped);
 229   if (NULL == head)
 230     return NULL;
 231   return head->api;
 232 }
 233
 234
 235 /**
 236  * Convert a given address to a human-readable format.  Note that the
 237  * return value will be overwritten on the next call to this function.
 238  *
 239  * @param address the address to convert
 240  * @return statically allocated (!) human-readable address
 241  */
 242 const char *
 243 GST_plugins_a2s (const struct GNUNET_HELLO_Address *address)
 244 {
 245   struct GNUNET_TRANSPORT_PluginFunctions *api;
 246   static char unable_to_show[1024];
 247
 248   if (address == NULL)
 249     return "<inbound>";
 250   api = GST_plugins_printer_find (address->transport_name);
 251   if (NULL == api)
 252     return "<plugin unknown>";
 253   if (0 == address->address_length)
 254   {
 255     GNUNET_snprintf (unable_to_show, sizeof (unable_to_show),
 256                      "<unable to stringify %u-byte long address of %s transport>",
 257                      (unsigned int) address->address_length,
 258                      address->transport_name);
 259     return unable_to_show;
 260   }
 261   return api->address_to_string (NULL, address->address,
 262                                  address->address_length);
 263 }
 264
 265
 266 /* end of file gnunet-service-transport_plugins.c */