transport_api_monitor_plugins.c File Reference

montoring api for transport plugin session status More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_arm_service.h"
#include "gnunet_hello_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_transport_service.h"
#include "transport.h"

Include dependency graph for transport_api_monitor_plugins.c:

Go to the source code of this file.

Data Structures
struct	GNUNET_TRANSPORT_PluginMonitor
	Handle for a plugin session state monitor. More...
struct	GNUNET_TRANSPORT_PluginSession
	Abstract representation of a plugin's session. More...
struct	SearchContext
	Context information to be used while searching for operation contexts. More...

Functions
static void	do_plugin_connect (void *cls)
	Task run to re-establish the connection. More...
static int	free_entry (void *cls, uint32_t key, void *value)
	Free the session entry and notify the callback about its demise. More...
static void	reconnect_plugin_ctx (struct GNUNET_TRANSPORT_PluginMonitor *pm)
	Cut the existing connection and reconnect. More...
static uint32_t	wrap_id (uint64_t id)
	Convert 64-bit session ID to 32-bit index for hash map. More...
static int	locate_by_id (void *cls, uint32_t key, void *value)
	Locate a session entry. More...
static int	check_event (void *cls, const struct TransportPluginMonitorMessage *tpmm)
	Function called with responses from the service. More...
static void	handle_event (void *cls, const struct TransportPluginMonitorMessage *tpmm)
	Function called with responses from the service. More...
static void	handle_sync (void *cls, const struct GNUNET_MessageHeader *msg)
	Function called with sync responses from the service. More...
static void	mq_error_handler (void *cls, enum GNUNET_MQ_Error error)
	Generic error handler, called with the appropriate error code and the same closure specified at the creation of the message queue. More...
struct GNUNET_TRANSPORT_PluginMonitor *	GNUNET_TRANSPORT_monitor_plugins (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_TRANSPORT_SessionMonitorCallback cb, void *cb_cls)
	Install a plugin session state monitor callback. More...
void	GNUNET_TRANSPORT_monitor_plugins_cancel (struct GNUNET_TRANSPORT_PluginMonitor *pm)
	Cancel monitoring the plugin session state. More...

Detailed Description

montoring api for transport plugin session status

Author

Christian Grothoff

Definition in file transport_api_monitor_plugins.c.

Function Documentation

do_plugin_connect()

static void do_plugin_connect ( void *  cls )

static

Task run to re-establish the connection.

Parameters

cls	our struct GNUNET_TRANSPORT_PluginMonitor *

Definition at line 370 of file transport_api_monitor_plugins.c.

{
  struct GNUNET_TRANSPORT_PluginMonitor *pm = cls;
  struct GNUNET_MQ_MessageHandler handlers[] = {
    GNUNET_MQ_hd_var_size (event,
                           GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_EVENT,
                           struct TransportPluginMonitorMessage,
                           pm),
    GNUNET_MQ_hd_fixed_size (sync,
                             GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_SYNC,
                             struct GNUNET_MessageHeader,
                             pm),
    GNUNET_MQ_handler_end ()
  };
  struct GNUNET_MessageHeader *msg;
  struct GNUNET_MQ_Envelope *env;
 
  pm->reconnect_task = NULL;
  pm->mq = GNUNET_CLIENT_connect (pm->cfg,
                                  "transport",
                                  handlers,
                                  &mq_error_handler,
                                  pm);
  if (NULL == pm->mq)
    return;
  env = GNUNET_MQ_msg (msg,
                       GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_START);
  GNUNET_MQ_send (pm->mq,
                  env);
}

References GNUNET_TRANSPORT_PluginMonitor::cfg, env, GNUNET_CLIENT_connect(), GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_EVENT, GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_START, GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_SYNC, GNUNET_MQ_handler_end, GNUNET_MQ_hd_fixed_size, GNUNET_MQ_hd_var_size, GNUNET_MQ_msg, GNUNET_MQ_send(), handlers, GNUNET_TRANSPORT_PluginMonitor::mq, mq_error_handler(), msg, pm, and GNUNET_TRANSPORT_PluginMonitor::reconnect_task.

Referenced by GNUNET_TRANSPORT_monitor_plugins(), and reconnect_plugin_ctx().

Here is the call graph for this function:

Here is the caller graph for this function:

free_entry()

static int free_entry ( void *  cls, uint32_t  key, void *  value  )

static

Free the session entry and notify the callback about its demise.

Parameters

cls	our struct GNUNET_TRANSPORT_PluginMonitor
key	key of the session in the map
value	the session to free

Returns

GNUNET_OK (continue to iterate)

Definition at line 114 of file transport_api_monitor_plugins.c.

{
  struct GNUNET_TRANSPORT_PluginMonitor *pm = cls;
  struct GNUNET_TRANSPORT_PluginSession *ps = value;
 
  pm->cb (pm->cb_cls,
          ps,
          &ps->client_ctx,
          NULL);
  GNUNET_break (GNUNET_YES ==
                GNUNET_CONTAINER_multihashmap32_remove (pm->sessions,
                                                        key,
                                                        ps));
  GNUNET_break (NULL == ps->client_ctx);
  GNUNET_free (ps);
  return GNUNET_OK;
}

References GNUNET_TRANSPORT_PluginMonitor::cb, GNUNET_TRANSPORT_PluginMonitor::cb_cls, GNUNET_TRANSPORT_PluginSession::client_ctx, GNUNET_break, GNUNET_CONTAINER_multihashmap32_remove(), GNUNET_free, GNUNET_OK, GNUNET_YES, key, pm, GNUNET_TRANSPORT_PluginMonitor::sessions, and value.

Referenced by GNUNET_TRANSPORT_monitor_plugins_cancel(), and reconnect_plugin_ctx().

Here is the call graph for this function:

Here is the caller graph for this function:

reconnect_plugin_ctx()

static void reconnect_plugin_ctx ( struct GNUNET_TRANSPORT_PluginMonitor *  pm )

static

Cut the existing connection and reconnect.

Parameters

pm	our context

Definition at line 141 of file transport_api_monitor_plugins.c.

{
  GNUNET_MQ_destroy (pm->mq);
  pm->mq = NULL;
  GNUNET_CONTAINER_multihashmap32_iterate (pm->sessions,
                                           &free_entry,
                                           pm);
  pm->backoff = GNUNET_TIME_STD_BACKOFF (pm->backoff);
  pm->reconnect_task = GNUNET_SCHEDULER_add_delayed (pm->backoff,
                                                     &do_plugin_connect,
                                                     pm);
}

References GNUNET_TRANSPORT_PluginMonitor::backoff, do_plugin_connect(), free_entry(), GNUNET_CONTAINER_multihashmap32_iterate(), GNUNET_MQ_destroy(), GNUNET_SCHEDULER_add_delayed(), GNUNET_TIME_STD_BACKOFF, GNUNET_TRANSPORT_PluginMonitor::mq, pm, GNUNET_TRANSPORT_PluginMonitor::reconnect_task, and GNUNET_TRANSPORT_PluginMonitor::sessions.

Referenced by handle_event(), and mq_error_handler().

Here is the call graph for this function:

Here is the caller graph for this function:

wrap_id()

static uint32_t wrap_id ( uint64_t  id )

static

Convert 64-bit session ID to 32-bit index for hash map.

Parameters

id	64-bit session ID

Returns

32-bit hash map index

Definition at line 162 of file transport_api_monitor_plugins.c.

{
  return ((uint32_t) id) ^ ((uint32_t) (id >> 32));
}

Referenced by handle_event().

Here is the caller graph for this function:

locate_by_id()

static int locate_by_id ( void *  cls, uint32_t  key, void *  value  )

static

Locate a session entry.

Parameters

cls	our struct SearchContext
key	key of the session in the map
value	a session

Returns

GNUNET_OK (continue to iterate), or GNUNET_SYSERR (match found)

Definition at line 194 of file transport_api_monitor_plugins.c.

{
  struct SearchContext *sc = cls;
  struct GNUNET_TRANSPORT_PluginSession *ps = value;
 
  if (sc->session_id == ps->session_id)
  {
    sc->ps = ps;
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

References GNUNET_OK, GNUNET_SYSERR, sc, GNUNET_TRANSPORT_PluginSession::session_id, and value.

Referenced by handle_event().

Here is the caller graph for this function:

check_event()

static int check_event ( void *  cls, const struct TransportPluginMonitorMessage *  tpmm  )

static

Function called with responses from the service.

Parameters

cls	our struct GNUNET_TRANSPORT_PluginMonitor *
tpmm	message with event data

Returns

#GNUNET_Ok if message is well-formed

Definition at line 218 of file transport_api_monitor_plugins.c.

{
  const char *pname;
  size_t pname_len;
  size_t paddr_len;
 
  pname = (const char *) &tpmm[1];
  pname_len = ntohs (tpmm->plugin_name_len);
  paddr_len = ntohs (tpmm->plugin_address_len);
  if ((pname_len
       + paddr_len
       + sizeof(struct TransportPluginMonitorMessage) != ntohs (
         tpmm->header.size)) ||
      ((0 != pname_len) &&
       ('\0' != pname[pname_len - 1])))
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

References GNUNET_break, GNUNET_OK, GNUNET_SYSERR, TransportPluginMonitorMessage::header, TransportPluginMonitorMessage::plugin_address_len, TransportPluginMonitorMessage::plugin_name_len, and GNUNET_MessageHeader::size.

handle_event()

static void handle_event ( void *  cls, const struct TransportPluginMonitorMessage *  tpmm  )

static

Function called with responses from the service.

Parameters

cls	our struct GNUNET_TRANSPORT_PluginMonitor *
tpmm	message with event data

Definition at line 249 of file transport_api_monitor_plugins.c.

{
  struct GNUNET_TRANSPORT_PluginMonitor *pm = cls;
  struct GNUNET_TRANSPORT_PluginSession *ps;
  const char *pname;
  const void *paddr;
  enum GNUNET_TRANSPORT_SessionState ss;
  size_t pname_len;
  size_t paddr_len;
  struct GNUNET_TRANSPORT_SessionInfo info;
  struct GNUNET_HELLO_Address addr;
  struct SearchContext rv;
 
  pname = (const char *) &tpmm[1];
  pname_len = ntohs (tpmm->plugin_name_len);
  paddr_len = ntohs (tpmm->plugin_address_len);
  paddr = &pname[pname_len];
  ps = NULL;
  ss = (enum GNUNET_TRANSPORT_SessionState) ntohs (tpmm->session_state);
  if (GNUNET_TRANSPORT_SS_INIT == ss)
  {
    ps = GNUNET_new (struct GNUNET_TRANSPORT_PluginSession);
    ps->session_id = tpmm->session_id;
    (void) GNUNET_CONTAINER_multihashmap32_put (pm->sessions,
                                                wrap_id (tpmm->session_id),
                                                ps,
                                                GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
  }
  else
  {
    rv.session_id = tpmm->session_id;
    rv.ps = NULL;
    (void) GNUNET_CONTAINER_multihashmap32_get_multiple (pm->sessions,
                                                         wrap_id (
                                                           tpmm->session_id),
                                                         &locate_by_id,
                                                         &rv);
    ps = rv.ps;
    if (NULL == ps)
    {
      GNUNET_break (0);
      reconnect_plugin_ctx (pm);
      return;
    }
  }
  info.state = ss;
  info.is_inbound = (int16_t) ntohs (tpmm->is_inbound);
  info.num_msg_pending = ntohl (tpmm->msgs_pending);
  info.num_bytes_pending = ntohl (tpmm->bytes_pending);
  info.receive_delay = GNUNET_TIME_absolute_ntoh (tpmm->delay);
  info.session_timeout = GNUNET_TIME_absolute_ntoh (tpmm->timeout);
  info.address = &addr;
  addr.peer = tpmm->peer;
  addr.address = (0 == paddr_len) ? NULL : paddr;
  addr.address_length = paddr_len;
  addr.transport_name = (0 == pname_len) ? NULL : pname;
  addr.local_info = GNUNET_HELLO_ADDRESS_INFO_NONE;
  pm->cb (pm->cb_cls,
          ps,
          &ps->client_ctx,
          &info);
 
  if (GNUNET_TRANSPORT_SS_DONE == ss)
  {
    GNUNET_break (NULL == ps->client_ctx);
    GNUNET_assert (GNUNET_YES ==
                   GNUNET_CONTAINER_multihashmap32_remove (pm->sessions,
                                                           wrap_id (
                                                             tpmm->session_id),
                                                           ps));
    GNUNET_free (ps);
  }
}

References GNUNET_HELLO_Address::address, GNUNET_HELLO_Address::address_length, TransportPluginMonitorMessage::bytes_pending, GNUNET_TRANSPORT_PluginMonitor::cb, GNUNET_TRANSPORT_PluginMonitor::cb_cls, GNUNET_TRANSPORT_PluginSession::client_ctx, TransportPluginMonitorMessage::delay, GNUNET_assert, GNUNET_break, GNUNET_CONTAINER_multihashmap32_get_multiple(), GNUNET_CONTAINER_multihashmap32_put(), GNUNET_CONTAINER_multihashmap32_remove(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE, GNUNET_free, GNUNET_HELLO_ADDRESS_INFO_NONE, GNUNET_new, GNUNET_TIME_absolute_ntoh(), GNUNET_TRANSPORT_SS_DONE, GNUNET_TRANSPORT_SS_INIT, GNUNET_YES, info, TransportPluginMonitorMessage::is_inbound, GNUNET_HELLO_Address::local_info, locate_by_id(), TransportPluginMonitorMessage::msgs_pending, GNUNET_HELLO_Address::peer, TransportPluginMonitorMessage::peer, TransportPluginMonitorMessage::plugin_address_len, TransportPluginMonitorMessage::plugin_name_len, pm, SearchContext::ps, reconnect_plugin_ctx(), TransportPluginMonitorMessage::session_id, GNUNET_TRANSPORT_PluginSession::session_id, SearchContext::session_id, TransportPluginMonitorMessage::session_state, GNUNET_TRANSPORT_PluginMonitor::sessions, TransportPluginMonitorMessage::timeout, GNUNET_HELLO_Address::transport_name, and wrap_id().

Here is the call graph for this function:

handle_sync()

static void handle_sync ( void *  cls, const struct GNUNET_MessageHeader *  msg  )

static

Function called with sync responses from the service.

Parameters

cls	our struct GNUNET_TRANSPORT_PluginMonitor *
msg	message from the service

Definition at line 332 of file transport_api_monitor_plugins.c.

{
  struct GNUNET_TRANSPORT_PluginMonitor *pm = cls;
 
  /* we are in sync, notify callback */
  pm->cb (pm->cb_cls,
          NULL,
          NULL,
          NULL);
}

References GNUNET_TRANSPORT_PluginMonitor::cb, GNUNET_TRANSPORT_PluginMonitor::cb_cls, and pm.

mq_error_handler()

static void mq_error_handler ( void *  cls, enum GNUNET_MQ_Error  error  )

static

Generic error handler, called with the appropriate error code and the same closure specified at the creation of the message queue.

Not every message queue implementation supports an error handler.

Parameters

cls	closure with the struct GNUNET_NSE_Handle *
error	error code

Definition at line 355 of file transport_api_monitor_plugins.c.

{
  struct GNUNET_TRANSPORT_PluginMonitor *pm = cls;
 
  reconnect_plugin_ctx (pm);
}

References pm, and reconnect_plugin_ctx().

Referenced by do_plugin_connect().

Here is the call graph for this function:

Here is the caller graph for this function: