-doxygen
[oweals/gnunet.git] / src / transport / gnunet-service-transport_plugins.c
index c4bc030391ede724297f9a1da8bb6db7f9c8d923..83c062ec3715c7f94f1ec28bc5fb61af62bfe6eb 100644 (file)
@@ -24,6 +24,8 @@
  * @author Christian Grothoff
  */
 #include "platform.h"
+#include "gnunet-service-transport.h"
+#include "gnunet-service-transport_hello.h"
 #include "gnunet-service-transport_plugins.h"
 
 /**
@@ -73,7 +75,7 @@ static struct TransportPlugin *plugins_head;
 /**
  * Head of DLL of all loaded plugins.
  */
-// static struct TransportPlugin *plugins_tail;
+static struct TransportPlugin *plugins_tail;
 
 
 
@@ -85,67 +87,157 @@ static struct TransportPlugin *plugins_head;
  *
  * @param recv_cb function to call when data is received
  * @param address_cb function to call when our public addresses changed
- * @param traffic_cb function to call for flow control
+ * @param session_start_cb function to call when a session was created
  * @param session_end_cb function to call when a session was terminated
- * @param cost_cb function to call about ATS cost changes
+ * @param address_type_cb function to call when a address type is requested
+ * @param metric_update_cb function to call when address metrics change
  */
-void 
+void
 GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
-                 GNUNET_TRANSPORT_AddressNotification address_cb,
-                 GNUNET_TRANSPORT_TrafficReport traffic_cb,
-                 GNUNET_TRANSPORT_SessionEnd session_end_cb,
-                 GNUNET_TRANSPORT_CostReport cost_cb)
+                  GNUNET_TRANSPORT_AddressNotification address_cb,
+                  GNUNET_TRANSPORT_SessionStart session_start_cb,
+                  GNUNET_TRANSPORT_SessionEnd session_end_cb,
+                  GNUNET_TRANSPORT_AddressToType address_type_cb,
+                  GNUNET_TRANSPORT_UpdateAddressMetrics metric_update_cb)
 {
-#if 0
   struct TransportPlugin *plug;
+  struct TransportPlugin *next;
+  unsigned long long tneigh;
   char *libname;
+  char *plugs;
+  char *pos;
+  int fail;
 
-  /* load plugins... */
-  no_transports = 1;
-  if (GNUNET_OK ==
-      GNUNET_CONFIGURATION_get_value_string (c,
-                                             "TRANSPORT", "PLUGINS", &plugs))
+  if (GNUNET_OK !=
+      GNUNET_CONFIGURATION_get_value_number (GST_cfg, "TRANSPORT",
+                                             "NEIGHBOUR_LIMIT", &tneigh))
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                _("Transport service is lacking NEIGHBOUR_LIMIT option.\n"));
+    return;
+  }
+  if (GNUNET_OK !=
+      GNUNET_CONFIGURATION_get_value_string (GST_cfg, "TRANSPORT", "PLUGINS",
+                                             &plugs))
+    return;
+  GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Starting transport plugins `%s'\n"),
+              plugs);
+  for (pos = strtok (plugs, " "); pos != NULL; pos = strtok (NULL, " "))
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Loading `%s' transport plugin\n"),
+                pos);
+    GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", pos);
+    plug = GNUNET_malloc (sizeof (struct TransportPlugin));
+    plug->short_name = GNUNET_strdup (pos);
+    plug->lib_name = libname;
+    plug->env.cfg = GST_cfg;
+    plug->env.my_identity = &GST_my_identity;
+    plug->env.get_our_hello = &GST_hello_get;
+    plug->env.cls = plug->short_name;
+    plug->env.receive = recv_cb;
+    plug->env.notify_address = address_cb;
+    plug->env.session_start = session_start_cb;
+    plug->env.session_end = session_end_cb;
+    plug->env.get_address_type = address_type_cb;
+    plug->env.update_address_metrics = metric_update_cb;
+    plug->env.max_connections = tneigh;
+    plug->env.stats = GST_stats;
+    GNUNET_CONTAINER_DLL_insert (plugins_head, plugins_tail, plug);
+  }
+  GNUNET_free (plugs);
+  next = plugins_head;
+  while (next != NULL)
+  {
+    plug = next;
+    next = plug->next;
+    plug->api = GNUNET_PLUGIN_load (plug->lib_name, &plug->env);
+    if (plug->api == NULL)
+    {
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Failed to load transport plugin for `%s'\n"),
+                  plug->lib_name);
+      GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
+      GNUNET_free (plug->short_name);
+      GNUNET_free (plug->lib_name);
+      GNUNET_free (plug);
+      continue;
+    }
+    fail = GNUNET_NO;
+    if (NULL == plug->api->address_pretty_printer)
     {
-      GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-                  _("Starting transport plugins `%s'\n"), plugs);
-      pos = strtok (plugs, " ");
-      while (pos != NULL)
-        {
-         
-         GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-                     _("Loading `%s' transport plugin\n"), name);
-         GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", name);
-         plug = GNUNET_malloc (sizeof (struct TransportPlugin));
-         plug->short_name = GNUNET_strdup (name);
-         plug->lib_name = libname;
-         plug->env.cfg = cfg;
-         plug->env.my_identity = &my_identity;
-         plug->env.our_hello = &our_hello;
-         plug->env.cls = plug->short_name;
-         plug->env.receive = &plugin_env_receive;
-         plug->env.notify_address = &plugin_env_notify_address;
-         plug->env.session_end = &plugin_env_session_end;
-         plug->env.max_connections = max_connect_per_transport;
-         plug->env.stats = stats;
-         plug->next = plugins;
-         plugins = plug;
-         plug->api = GNUNET_PLUGIN_load (libname, &plug->env);
-         if (plug->api == NULL)
-           {
-             GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-                         _("Failed to load transport plugin for `%s'\n"), name);
-             GNUNET_free (plug->short_name);
-             plugins = plug->next;
-             GNUNET_free (libname);
-             GNUNET_free (plug);
-           }
-          start_transport (server, pos);
-          no_transports = 0;
-          pos = strtok (NULL, " ");
-        }
-      GNUNET_free (plugs);
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "address_pretty_printer",
+                  plug->lib_name);
     }
-#endif
+    if (NULL == plug->api->address_to_string)
+    {
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "address_to_string",
+                  plug->lib_name);
+    }
+    if (NULL == plug->api->string_to_address)
+    {
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "string_to_address",
+                  plug->lib_name);
+    }
+    if (NULL == plug->api->check_address)
+    {
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "check_address",
+                  plug->lib_name);
+    }
+    if (NULL == plug->api->get_session)
+    {
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "get_session",
+                  plug->lib_name);
+    }
+    if (NULL == plug->api->get_network)
+    {
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "get_network",
+                  plug->lib_name);
+    }
+    if (NULL == plug->api->send)
+    {
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "send",
+                  plug->lib_name);
+    }
+    if (NULL == plug->api->disconnect)
+    {
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "disconnect",
+                  plug->lib_name);
+    }
+    if (GNUNET_YES == fail)
+    {
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Did not load plugin `%s' due to missing functions\n"),
+                  plug->lib_name);
+      GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
+      GNUNET_free (plug->short_name);
+      GNUNET_free (plug->lib_name);
+      GNUNET_free (plug);
+    }
+  }
 }
 
 
@@ -155,26 +247,16 @@ GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
 void
 GST_plugins_unload ()
 {
-#if 0
-  while (NULL != (plug = plugins))
-    {
-      if (plug->address_update_task != GNUNET_SCHEDULER_NO_TASK)
-       {
-         GNUNET_SCHEDULER_cancel (plug->address_update_task);
-         plug->address_update_task = GNUNET_SCHEDULER_NO_TASK;
-       }
-      GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
-      GNUNET_free (plug->lib_name);
-      GNUNET_free (plug->short_name);
-      while (NULL != (al = plug->addresses))
-        {
-          plug->addresses = al->next;
-          GNUNET_free (al);
-        }
-      plugins = plug->next;
-      GNUNET_free (plug);
-    }
-#endif
+  struct TransportPlugin *plug;
+
+  while (NULL != (plug = plugins_head))
+  {
+    GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
+    GNUNET_free (plug->lib_name);
+    GNUNET_free (plug->short_name);
+    GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
+    GNUNET_free (plug);
+  }
 }
 
 
@@ -197,30 +279,73 @@ GST_plugins_find (const char *name)
 }
 
 
+/**
+ * Obtain the plugin API based on a the stripped plugin name after the underscore.
+ *
+ * Example: GST_plugins_printer_find (http_client) will return all plugins
+ * starting with the prefix "http":
+ * http_client or server if loaded
+ *
+ * @param name name of the plugin
+ * @return the plugin's API, NULL if the plugin is not loaded
+ */
+struct GNUNET_TRANSPORT_PluginFunctions *
+GST_plugins_printer_find (const char *name)
+{
+  struct TransportPlugin *head = plugins_head;
+
+  char *stripped = GNUNET_strdup (name);
+  char *sep = strchr (stripped, '_');
+  if (NULL != sep)
+    sep[0] = '\0';
+
+  while (head != NULL)
+  {
+    if (head->short_name == strstr (head->short_name, stripped))
+        break;
+    head = head->next;
+  }
+  GNUNET_free (stripped);
+  if (NULL == head)
+    return NULL;
+  return head->api;
+}
+
+
 /**
  * Convert a given address to a human-readable format.  Note that the
  * return value will be overwritten on the next call to this function.
- * 
- * @param name plugin name
- * @param addr binary address in plugin-specific format
- * @param addrlen number of bytes in 'addr'
+ *
+ * @param address the address to convert
  * @return statically allocated (!) human-readable address
  */
 const char *
-GST_plugins_a2s (const char *name,
-                const void *addr,
-                size_t addrlen)
+GST_plugins_a2s (const struct GNUNET_HELLO_Address *address)
 {
   struct GNUNET_TRANSPORT_PluginFunctions *api;
+  static char unable_to_show[1024];
+  static const char *s;
 
-  if (name == NULL)
-    return NULL;
-  api = GST_plugins_find (name);
-  if ( (api == NULL) || (addrlen == 0) || (addr == NULL) )
-    return NULL;
-  return api->address_to_string (NULL,
-                                addr,
-                                addrlen);
+  if (address == NULL)
+  {
+       GNUNET_break (0); /* a HELLO address cannot be NULL */
+    return "<invalid>";
+  }
+  if (0 == address->address_length)
+    return TRANSPORT_SESSION_INBOUND_STRING; /* Addresse with length 0 are inbound, address->address itself may be NULL */
+  api = GST_plugins_printer_find (address->transport_name);
+  if (NULL == api)
+    return "<plugin unknown>";
+  if (0 == address->address_length)
+  {
+    GNUNET_snprintf (unable_to_show, sizeof (unable_to_show),
+                     "<unable to stringify %u-byte long address of %s transport>",
+                     (unsigned int) address->address_length,
+                     address->transport_name);
+    return unable_to_show;
+  }
+  return (NULL != (s = api->address_to_string (NULL, address->address,
+                                 address->address_length)) ? s : "<invalid>");
 }