gnunet-service-transport_plugins.c File Reference

plugin management More...

#include "platform.h"
#include "gnunet-service-transport.h"
#include "gnunet-service-transport_hello.h"
#include "gnunet-service-transport_ats.h"
#include "gnunet-service-transport_plugins.h"

Include dependency graph for gnunet-service-transport_plugins.c:

Go to the source code of this file.

Data Structures
struct	TransportPlugin
	Entry in doubly-linked list of all of our plugins. More...

Functions
static void	plugin_env_update_distance (void *cls, const struct GNUNET_HELLO_Address *address, uint32_t distance)
	Function that will be called to update metrics for an address. More...
static enum GNUNET_NetworkType	plugin_env_address_to_type (void *cls, const struct sockaddr *addr, size_t addrlen)
	Function that will be called to figure if an address is an loopback, LAN, WAN etc. More...
void	GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb, GNUNET_TRANSPORT_AddressNotification address_cb, GNUNET_TRANSPORT_SessionStart session_start_cb, GNUNET_TRANSPORT_SessionEnd session_end_cb)
	Load and initialize all plugins. More...
void	GST_plugins_unload ()
	Unload all plugins. More...
struct GNUNET_TRANSPORT_PluginFunctions *	GST_plugins_find (const char *name)
	Obtain the plugin API based on a plugin name. More...
struct GNUNET_TRANSPORT_PluginFunctions *	GST_plugins_printer_find (const char *name)
	Obtain the plugin API based on a the stripped plugin name after the underscore. More...
const char *	GST_plugins_a2s (const struct GNUNET_HELLO_Address *address)
	Convert a given address to a human-readable format. More...
void	GST_plugins_monitor_subscribe (GNUNET_TRANSPORT_SessionInfoCallback cb, void *cb_cls)
	Register callback with all plugins to monitor their status. More...

Variables
static struct TransportPlugin *	plugins_head
	Head of DLL of all loaded plugins. More...
static struct TransportPlugin *	plugins_tail
	Head of DLL of all loaded plugins. More...

Detailed Description

plugin management

Author

Christian Grothoff

Definition in file gnunet-service-transport_plugins.c.

Function Documentation

plugin_env_update_distance()

static void plugin_env_update_distance ( void *  cls, const struct GNUNET_HELLO_Address *  address, uint32_t  distance  )

static

Function that will be called to update metrics for an address.

Parameters

cls	closure
address	address to update metrics for
distance	new distance

Definition at line 89 of file gnunet-service-transport_plugins.c.

{
  GST_ats_update_distance (address,
                           distance);
}

Referenced by GST_plugins_load().

Here is the caller graph for this function:

plugin_env_address_to_type()

static enum GNUNET_NetworkType plugin_env_address_to_type ( void *  cls, const struct sockaddr *  addr, size_t  addrlen  )

static

Function that will be called to figure if an address is an loopback, LAN, WAN etc.

address

Parameters

cls	closure
addr	binary address
addrlen	length of the addr

Returns

type of the network addr belongs to

Definition at line 89 of file gnunet-service-transport_plugins.c.

{
  if (NULL == GST_is)
  {
    GNUNET_break (0);
    return GNUNET_NT_UNSPECIFIED;
  }
  return GNUNET_NT_scanner_get_type (GST_is,
                                     addr,
                                     addrlen);
}

References address, and GST_ats_update_distance().

Referenced by GST_plugins_load().

Here is the call graph for this function:

Here is the caller graph for this function:

GST_plugins_load()

void GST_plugins_load	(	GNUNET_TRANSPORT_PluginReceiveCallback	recv_cb,
		GNUNET_TRANSPORT_AddressNotification	address_cb,
		GNUNET_TRANSPORT_SessionStart	session_start_cb,
		GNUNET_TRANSPORT_SessionEnd	session_end_cb
	)

Load and initialize all plugins.

The respective functions will be invoked by the plugins when the respective events happen. The closure will be set to a 'const char*' containing the name of the plugin that caused the call.

Parameters

recv_cb	function to call when data is received
address_cb	function to call when our public addresses changed
session_start_cb	function to call when a session was created
session_end_cb	function to call when a session was terminated

Definition at line 124 of file gnunet-service-transport_plugins.c.

{
  struct TransportPlugin *plug;
  struct TransportPlugin *next;
  unsigned long long tneigh;
  char *libname;
  char *plugs;
  char *pos;
  int fail;
 
  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_new (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 = &plugin_env_address_to_type;
    plug->env.update_address_distance = &plugin_env_update_distance;
    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 (NULL != next)
  {
    plug = next;
    next = plug->next;
    plug->api = GNUNET_PLUGIN_load (plug->lib_name,
                                    &plug->env);
    if (NULL == plug->api)
    {
      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)
    {
      fail = GNUNET_YES;
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  _ ("Missing function `%s' in transport plugin for `%s'\n"),
                  "address_pretty_printer",
                  plug->lib_name);
    }
    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_peer)
    {
      fail = GNUNET_YES;
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  _ ("Missing function `%s' in transport plugin for `%s'\n"),
                  "disconnect_peer",
                  plug->lib_name);
    }
    if (NULL == plug->api->disconnect_session)
    {
      fail = GNUNET_YES;
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  _ ("Missing function `%s' in transport plugin for `%s'\n"),
                  "disconnect_session",
                  plug->lib_name);
    }
    if (NULL == plug->api->query_keepalive_factor)
    {
      fail = GNUNET_YES;
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  _ ("Missing function `%s' in transport plugin for `%s'\n"),
                  "query_keepalive_factor",
                  plug->lib_name);
    }
    if (NULL == plug->api->update_session_timeout)
    {
      fail = GNUNET_YES;
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  _ ("Missing function `%s' in transport plugin for `%s'\n"),
                  "update_session_timeout",
                  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_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
      GNUNET_CONTAINER_DLL_remove (plugins_head,
                                   plugins_tail,
                                   plug);
      GNUNET_free (plug->short_name);
      GNUNET_free (plug->lib_name);
      GNUNET_free (plug);
    }
  }
}

References _, address_cb(), GNUNET_TRANSPORT_PluginFunctions::address_pretty_printer, GNUNET_TRANSPORT_PluginFunctions::address_to_string, TransportPlugin::api, GNUNET_TRANSPORT_PluginEnvironment::cfg, GNUNET_TRANSPORT_PluginFunctions::check_address, GNUNET_TRANSPORT_PluginEnvironment::cls, GNUNET_TRANSPORT_PluginFunctions::disconnect_peer, GNUNET_TRANSPORT_PluginFunctions::disconnect_session, TransportPlugin::env, GNUNET_TRANSPORT_PluginEnvironment::get_address_type, GNUNET_TRANSPORT_PluginFunctions::get_network, GNUNET_TRANSPORT_PluginEnvironment::get_our_hello, GNUNET_TRANSPORT_PluginFunctions::get_session, GNUNET_asprintf(), GNUNET_break, GNUNET_CONFIGURATION_get_value_number(), GNUNET_CONFIGURATION_get_value_string(), GNUNET_CONTAINER_DLL_insert, GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_INFO, GNUNET_free, GNUNET_log, GNUNET_new, GNUNET_NO, GNUNET_OK, GNUNET_PLUGIN_load(), GNUNET_PLUGIN_unload(), GNUNET_strdup, GNUNET_YES, GST_cfg, GST_hello_get(), GST_my_identity, GST_stats, TransportPlugin::lib_name, GNUNET_TRANSPORT_PluginEnvironment::max_connections, GNUNET_TRANSPORT_PluginEnvironment::my_identity, TransportPlugin::next, GNUNET_TRANSPORT_PluginEnvironment::notify_address, plugin_env_address_to_type(), plugin_env_update_distance(), plugins_head, plugins_tail, GNUNET_TRANSPORT_PluginFunctions::query_keepalive_factor, GNUNET_TRANSPORT_PluginEnvironment::receive, GNUNET_TRANSPORT_PluginFunctions::send, GNUNET_TRANSPORT_PluginEnvironment::session_end, GNUNET_TRANSPORT_PluginEnvironment::session_start, TransportPlugin::short_name, GNUNET_TRANSPORT_PluginEnvironment::stats, GNUNET_TRANSPORT_PluginFunctions::string_to_address, GNUNET_TRANSPORT_PluginEnvironment::update_address_distance, and GNUNET_TRANSPORT_PluginFunctions::update_session_timeout.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

GST_plugins_unload()

void GST_plugins_unload

(

void

)

Unload all plugins.

Definition at line 314 of file gnunet-service-transport_plugins.c.

{
  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);
  }
}

References TransportPlugin::api, GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_PLUGIN_unload(), TransportPlugin::lib_name, plugins_head, plugins_tail, and TransportPlugin::short_name.

Referenced by shutdown_task().

Here is the call graph for this function:

Here is the caller graph for this function:

GST_plugins_find()

struct GNUNET_TRANSPORT_PluginFunctions* GST_plugins_find

(

const char *

name

)

Obtain the plugin API based on a plugin name.

Parameters

name	name of the plugin

Returns

the plugin's API, NULL if the plugin is not loaded

Definition at line 336 of file gnunet-service-transport_plugins.c.

{
  struct TransportPlugin *pos;
 
  for (pos = plugins_head; NULL != pos; pos = pos->next)
    if (0 == strcmp (name, pos->short_name))
      break;
  if (NULL == pos)
    return NULL;
  return pos->api;
}

References TransportPlugin::api, name, TransportPlugin::next, plugins_head, and TransportPlugin::short_name.

Referenced by add_valid_address(), GST_neighbours_calculate_receive_delay(), GST_neighbours_switch_to_address(), GST_validation_handle_address(), GST_validation_handle_ping(), GST_validation_handle_pong(), inbound_bw_tracker_update(), kill_session(), multicast_pong(), send_syn(), send_syn_ack_message(), send_with_session(), switch_address_bl_check_cont(), and transmit_ping_if_allowed().

Here is the caller graph for this function:

GST_plugins_printer_find()

struct GNUNET_TRANSPORT_PluginFunctions* GST_plugins_printer_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

Parameters

name	name of the plugin

Returns

the plugin's API, NULL if the plugin is not loaded

Definition at line 360 of file gnunet-service-transport_plugins.c.

{
  struct TransportPlugin *pos;
  char *stripped = GNUNET_strdup (name);
  char *sep = strchr (stripped, '_');
 
  if (NULL != sep)
    sep[0] = '\0';
  for (pos = plugins_head; NULL != pos; pos = pos->next)
    if (pos->short_name == strstr (pos->short_name, stripped))
      break;
  GNUNET_free (stripped);
  if (NULL == pos)
    return NULL;
  return pos->api;
}

References TransportPlugin::api, GNUNET_free, GNUNET_strdup, name, TransportPlugin::next, plugins_head, and TransportPlugin::short_name.

Referenced by GST_plugins_a2s(), and handle_client_address_to_string().

Here is the caller graph for this function:

GST_plugins_a2s()

const char* GST_plugins_a2s

(

const struct GNUNET_HELLO_Address *

address

)

Convert a given address to a human-readable format.

Note that the return value will be overwritten on the next call to this function.

Parameters

address

the address to convert

Returns

statically allocated (!) human-readable address

Definition at line 386 of file gnunet-service-transport_plugins.c.

{
  struct GNUNET_TRANSPORT_PluginFunctions *api;
  static char unable_to_show[1024];
  static const char *s;
 
  if (NULL == address)
    return "<NULL>";
  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)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Failed to find transport plugin `%s'\n",
                address->transport_name);
    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>");
}

References address, GNUNET_TRANSPORT_PluginFunctions::address_to_string, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_snprintf(), GST_plugins_printer_find(), and TRANSPORT_SESSION_INBOUND_STRING.

Referenced by add_valid_address(), connect_bl_check_cont(), GST_ats_add_address(), GST_ats_add_inbound_address(), GST_ats_block_address(), GST_ats_expire_address(), GST_ats_update_utilization(), GST_hello_modify_addresses(), GST_neighbours_session_terminated(), GST_neighbours_switch_to_address(), GST_validation_handle_address(), GST_validation_handle_ping(), GST_validation_handle_pong(), neighbours_changed_notification(), plugin_env_session_end(), plugin_env_session_start(), plugin_env_session_start_bl_check_cont(), revalidate_address(), send_peer_information(), send_session_syn_ack_cont(), send_syn(), send_syn_ack_message(), send_with_session(), set_primary_address(), switch_address_bl_check_cont(), transmit_ping_if_allowed(), and unblock_address().

Here is the call graph for this function:

Here is the caller graph for this function:

GST_plugins_monitor_subscribe()

void GST_plugins_monitor_subscribe	(	GNUNET_TRANSPORT_SessionInfoCallback	cb,
		void *	cb_cls
	)

Register callback with all plugins to monitor their status.

Parameters

cb	callback to register, NULL to unsubscribe
cb_cls	closure for cb

Definition at line 422 of file gnunet-service-transport_plugins.c.

{
  struct TransportPlugin *pos;
 
  for (pos = plugins_head; NULL != pos; pos = pos->next)
    if (NULL == pos->api->setup_monitor)
      GNUNET_break (0);
    else
      pos->api->setup_monitor (pos->api->cls,
                               cb,
                               cb_cls);
}

References TransportPlugin::api, GNUNET_TRANSPORT_PluginFunctions::cls, GNUNET_break, TransportPlugin::next, plugins_head, and GNUNET_TRANSPORT_PluginFunctions::setup_monitor.

Referenced by handle_client_monitor_plugins(), and plugin_session_info_cb().

Here is the caller graph for this function:

Variable Documentation

plugins_head

struct TransportPlugin* plugins_head

static

Head of DLL of all loaded plugins.

Definition at line 73 of file gnunet-service-transport_plugins.c.

Referenced by GST_plugins_find(), GST_plugins_load(), GST_plugins_monitor_subscribe(), GST_plugins_printer_find(), and GST_plugins_unload().

plugins_tail

struct TransportPlugin* plugins_tail

static

Head of DLL of all loaded plugins.

Definition at line 78 of file gnunet-service-transport_plugins.c.

Referenced by GST_plugins_load(), and GST_plugins_unload().