transport_api_monitor.c File Reference

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_transport_monitor_service.h"
#include "transport.h"

Include dependency graph for transport_api_monitor.c:

Go to the source code of this file.

Data Structures
struct	GNUNET_TRANSPORT_MonitorContext
	Opaque handle to the transport service for monitors. More...
struct	GNUNET_TRANSPORT_LinkListContext
	Opaque handle for a GNUNET_TRANSPORT_links_list() operation. More...

Functions
static void	reconnect (struct GNUNET_TRANSPORT_MonitorContext *mc)
	(re)connect our monitor to the transport service
static void	send_start_monitor (struct GNUNET_TRANSPORT_MonitorContext *mc)
	Send message to the transport service about our monitoring desire.
static void	disconnect (struct GNUNET_TRANSPORT_MonitorContext *mc)
	Disconnect from the transport service.
static void	error_handler (void *cls, enum GNUNET_MQ_Error error)
	Function called on MQ errors.
static int	check_monitor_data (void *cls, const struct GNUNET_TRANSPORT_MonitorData *md)
	Transport service sends us information about what is going on.
static void	handle_monitor_data (void *cls, const struct GNUNET_TRANSPORT_MonitorData *md)
	Transport service sends us information about what is going on.
static void	handle_monitor_end (void *cls, const struct GNUNET_MessageHeader *me)
	One shot was requested, and transport service is done.
struct GNUNET_TRANSPORT_MonitorContext *	GNUNET_TRANSPORT_monitor (const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_PeerIdentity *peer, int one_shot, GNUNET_TRANSPORT_MonitorCallback cb, void *cb_cls)
	Return information about a specific peer or all peers currently known to transport service once or in monitoring mode.
void	GNUNET_TRANSPORT_monitor_cancel (struct GNUNET_TRANSPORT_MonitorContext *mc)
	Cancel request to monitor peers.
static void	link_list_done (struct GNUNET_TRANSPORT_LinkListContext *llc)
	Tell the caller we are done and tear the operation down.
static void	link_list_error_handler (void *cls, enum GNUNET_MQ_Error error)
	Function called on MQ errors.
static enum GNUNET_GenericReturnValue	check_link_list_response (void *cls, const struct GNUNET_TRANSPORT_LinkListResponse *resp)
	Validate a link listing response.
static void	handle_link_list_response (void *cls, const struct GNUNET_TRANSPORT_LinkListResponse *resp)
	Handle a link listing response.
static void	handle_link_list_response_end (void *cls, const struct GNUNET_MessageHeader *msg)
	Handle the end of a link listing.
struct GNUNET_TRANSPORT_LinkListContext *	GNUNET_TRANSPORT_links_list (const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_PeerIdentity *peer, int include_unconfirmed, GNUNET_TRANSPORT_LinkCallback cb, void *cb_cls)
	Ask the transport service for the virtual links it currently has.
void	GNUNET_TRANSPORT_links_list_cancel (struct GNUNET_TRANSPORT_LinkListContext *llc)
	Cancel a request to list virtual links.

Function Documentation

reconnect()

static void reconnect ( struct GNUNET_TRANSPORT_MonitorContext *  mc )

static

(re)connect our monitor to the transport service

Parameters

mc	handle to reconnect

Definition at line 206 of file transport_api_monitor.c.

{
  struct GNUNET_MQ_MessageHandler handlers[] =
  { GNUNET_MQ_hd_var_size (monitor_data,
                           GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_DATA,
                           struct GNUNET_TRANSPORT_MonitorData,
                           mc),
    GNUNET_MQ_hd_fixed_size (monitor_end,
                             GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_END,
                             struct GNUNET_MessageHeader,
                             mc),
    GNUNET_MQ_handler_end () };
 
  mc->mq =
    GNUNET_CLIENT_connect (mc->cfg, "transport", handlers, &error_handler, mc);
  if (NULL == mc->mq)
    return;
  send_start_monitor (mc);
}

References error_handler(), GNUNET_CLIENT_connect(), GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_DATA, GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_END, GNUNET_MQ_handler_end, GNUNET_MQ_hd_fixed_size, GNUNET_MQ_hd_var_size, handlers, mc, and send_start_monitor().

Here is the call graph for this function:

send_start_monitor()

static void send_start_monitor ( struct GNUNET_TRANSPORT_MonitorContext *  mc )

static

Send message to the transport service about our monitoring desire.

Parameters

ai	address to delete

Definition at line 86 of file transport_api_monitor.c.

{
  struct GNUNET_MQ_Envelope *env;
  struct GNUNET_TRANSPORT_MonitorStart *smm;
 
  if (NULL == mc->mq)
    return;
  env = GNUNET_MQ_msg (smm, GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_START);
  smm->one_shot = htonl ((uint32_t) mc->one_shot);
  smm->peer = mc->peer;
  GNUNET_MQ_send (mc->mq, env);
}

References env, GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_START, GNUNET_MQ_msg, GNUNET_MQ_send(), mc, GNUNET_TRANSPORT_MonitorStart::one_shot, and GNUNET_TRANSPORT_MonitorStart::peer.

Referenced by reconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

disconnect()

static void disconnect ( struct GNUNET_TRANSPORT_MonitorContext *  mc )

static

Disconnect from the transport service.

Parameters

mc	service to disconnect from

Definition at line 106 of file transport_api_monitor.c.

{
  if (NULL == mc->mq)
    return;
  GNUNET_MQ_destroy (mc->mq);
  mc->mq = NULL;
}

References GNUNET_MQ_destroy(), and mc.

Referenced by error_handler(), GNUNET_TRANSPORT_monitor_cancel(), and handle_monitor_end().

Here is the call graph for this function:

Here is the caller graph for this function:

error_handler()

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

static

Function called on MQ errors.

Reconnects to the service.

Parameters

cls	our struct GNUNET_TRANSPORT_MonitorContext *
error	what error happened?

Definition at line 122 of file transport_api_monitor.c.

{
  struct GNUNET_TRANSPORT_MonitorContext *mc = cls;
 
  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              "MQ failure %d, reconnecting to transport service.\n",
              error);
  disconnect (mc);
  /* TODO: maybe do this with exponential backoff/delay */
  reconnect (mc);
}

References disconnect(), GNUNET_ERROR_TYPE_INFO, GNUNET_log, mc, and reconnect().

Referenced by reconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

check_monitor_data()

static int check_monitor_data ( void *  cls, const struct GNUNET_TRANSPORT_MonitorData *  md  )

static

Transport service sends us information about what is going on.

Check if md is well-formed.

Parameters

cls	our struct GNUNET_TRANSPORT_MonitorContext *
md	the monitor data we got

Returns

GNUNET_OK if smt is well-formed

Definition at line 144 of file transport_api_monitor.c.

{
  (void) cls;
  GNUNET_MQ_check_zero_termination (md);
  return GNUNET_OK;
}

References GNUNET_MQ_check_zero_termination, and GNUNET_OK.

handle_monitor_data()

static void handle_monitor_data ( void *  cls, const struct GNUNET_TRANSPORT_MonitorData *  md  )

static

Transport service sends us information about what is going on.

Parameters

cls	our struct GNUNET_TRANSPORT_MonitorContext *
md	monitor data

Definition at line 159 of file transport_api_monitor.c.

{
  struct GNUNET_TRANSPORT_MonitorContext *mc = cls;
  struct GNUNET_TRANSPORT_MonitorInformation mi;
 
  mi.address = (const char *) &md[1];
  mi.nt = ntohl (md->nt);
  mi.cs = ntohl (md->cs);
  mi.num_msg_pending = ntohl (md->num_msg_pending);
  mi.num_bytes_pending = ntohl (md->num_bytes_pending);
  mi.last_validation = GNUNET_TIME_absolute_ntoh (md->last_validation);
  mi.valid_until = GNUNET_TIME_absolute_ntoh (md->valid_until);
  mi.next_validation = GNUNET_TIME_absolute_ntoh (md->next_validation);
  mi.rtt = GNUNET_TIME_relative_ntoh (md->rtt);
  mc->cb (mc->cb_cls, &md->peer, &mi);
}

References GNUNET_TRANSPORT_MonitorInformation::address, GNUNET_TRANSPORT_MonitorInformation::cs, GNUNET_TRANSPORT_MonitorData::cs, GNUNET_TIME_absolute_ntoh(), GNUNET_TIME_relative_ntoh(), GNUNET_TRANSPORT_MonitorInformation::last_validation, GNUNET_TRANSPORT_MonitorData::last_validation, mc, GNUNET_TRANSPORT_MonitorInformation::next_validation, GNUNET_TRANSPORT_MonitorData::next_validation, GNUNET_TRANSPORT_MonitorInformation::nt, GNUNET_TRANSPORT_MonitorData::nt, GNUNET_TRANSPORT_MonitorInformation::num_bytes_pending, GNUNET_TRANSPORT_MonitorData::num_bytes_pending, GNUNET_TRANSPORT_MonitorInformation::num_msg_pending, GNUNET_TRANSPORT_MonitorData::num_msg_pending, GNUNET_TRANSPORT_MonitorData::peer, GNUNET_TRANSPORT_MonitorInformation::rtt, GNUNET_TRANSPORT_MonitorData::rtt, GNUNET_TRANSPORT_MonitorInformation::valid_until, and GNUNET_TRANSPORT_MonitorData::valid_until.

Here is the call graph for this function:

handle_monitor_end()

static void handle_monitor_end ( void *  cls, const struct GNUNET_MessageHeader *  me  )

static

One shot was requested, and transport service is done.

Parameters

cls	our struct GNUNET_TRANSPORT_MonitorContext *
me	end message

Definition at line 184 of file transport_api_monitor.c.

{
  struct GNUNET_TRANSPORT_MonitorContext *mc = cls;
 
  if (GNUNET_YES != mc->one_shot)
  {
    GNUNET_break (0);
    disconnect (mc);
    reconnect (mc);
    return;
  }
  mc->cb (mc->cb_cls, NULL, NULL);
  GNUNET_TRANSPORT_monitor_cancel (mc);
}

References disconnect(), GNUNET_break, GNUNET_TRANSPORT_monitor_cancel(), GNUNET_YES, mc, and reconnect().

Here is the call graph for this function:

link_list_done()

static void link_list_done ( struct GNUNET_TRANSPORT_LinkListContext *  llc )

static

Tell the caller we are done and tear the operation down.

Parameters

llc	operation that finished

Definition at line 323 of file transport_api_monitor.c.

{
  GNUNET_TRANSPORT_LinkCallback cb = llc->cb;
  void *cb_cls = llc->cb_cls;
 
  GNUNET_TRANSPORT_links_list_cancel (llc);
  cb (cb_cls, NULL, NULL);
}

References GNUNET_TRANSPORT_LinkListContext::cb, GNUNET_TRANSPORT_LinkListContext::cb_cls, GNUNET_TRANSPORT_links_list_cancel(), and llc.

Referenced by handle_link_list_response_end(), and link_list_error_handler().

Here is the call graph for this function:

Here is the caller graph for this function:

link_list_error_handler()

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

static

Function called on MQ errors.

There is nothing to retry – this is a one-shot request – so report the end of the listing.

Parameters

cls	our struct GNUNET_TRANSPORT_LinkListContext *
error	what error happened?

Definition at line 341 of file transport_api_monitor.c.

{
  struct GNUNET_TRANSPORT_LinkListContext *llc = cls;
 
  GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
              "Transport service disconnected while listing links (%d)\n",
              (int) error);
  link_list_done (llc);
}

References GNUNET_ERROR_TYPE_WARNING, GNUNET_log, link_list_done(), and llc.

Referenced by GNUNET_TRANSPORT_links_list().

Here is the call graph for this function:

Here is the caller graph for this function:

check_link_list_response()

static enum GNUNET_GenericReturnValue check_link_list_response ( void *  cls, const struct GNUNET_TRANSPORT_LinkListResponse *  resp  )

static

Validate a link listing response.

Parameters

cls	our struct GNUNET_TRANSPORT_LinkListContext *
resp	the response to check

Returns

GNUNET_OK if resp is well-formed

Definition at line 360 of file transport_api_monitor.c.

{
  const char *ccs = (const char *) &resp[1];
  uint16_t slen = ntohs (resp->header.size) - sizeof (*resp);
 
  (void) cls;
  if ((0 == slen) || ('\0' != ccs[slen - 1]))
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

References GNUNET_break, GNUNET_OK, GNUNET_SYSERR, GNUNET_TRANSPORT_LinkListResponse::header, and GNUNET_MessageHeader::size.

handle_link_list_response()

static void handle_link_list_response ( void *  cls, const struct GNUNET_TRANSPORT_LinkListResponse *  resp  )

static

Handle a link listing response.

Parameters

cls	our struct GNUNET_TRANSPORT_LinkListContext *
resp	the response

Definition at line 384 of file transport_api_monitor.c.

{
  struct GNUNET_TRANSPORT_LinkListContext *llc = cls;
  struct GNUNET_TRANSPORT_LinkInformation li;
 
  memset (&li, 0, sizeof (li));
  li.communicators = (const char *) &resp[1];
  li.route = (enum GNUNET_TRANSPORT_LinkRoute) ntohl (resp->route);
  li.confirmed = (int) ntohl (resp->confirmed);
  li.distance = ntohl (resp->distance);
  li.num_queues = ntohl (resp->num_queues);
  li.core_recv_window = (int) (int32_t) ntohl (resp->core_recv_window);
  li.stalled = ntohl (resp->stalled);
  li.pending = ntohl (resp->pending);
  li.fc_retransmit_count = ntohl (resp->fc_retransmit_count);
  li.available_fc_window_size = GNUNET_ntohll (resp->available_fc_window_size);
  li.incoming_fc_window_size_ram
    = GNUNET_ntohll (resp->incoming_fc_window_size_ram);
  li.incoming_fc_window_size = GNUNET_ntohll (resp->incoming_fc_window_size);
  li.incoming_fc_window_size_used
    = GNUNET_ntohll (resp->incoming_fc_window_size_used);
  li.incoming_fc_window_size_loss
    = (int64_t) GNUNET_ntohll ((uint64_t) resp->incoming_fc_window_size_loss);
  li.outbound_fc_window_size = GNUNET_ntohll (resp->outbound_fc_window_size);
  li.outbound_fc_window_size_used
    = GNUNET_ntohll (resp->outbound_fc_window_size_used);
  li.last_fc_rtt = GNUNET_TIME_relative_ntoh (resp->last_fc_rtt);
  li.other_rtt = GNUNET_TIME_relative_ntoh (resp->other_rtt);
  li.last_fc_transmission
    = GNUNET_TIME_absolute_ntoh (resp->last_fc_transmission);
  llc->cb (llc->cb_cls, &resp->target, &li);
}

References GNUNET_TRANSPORT_LinkInformation::available_fc_window_size, GNUNET_TRANSPORT_LinkListResponse::available_fc_window_size, GNUNET_TRANSPORT_LinkListContext::cb, GNUNET_TRANSPORT_LinkListContext::cb_cls, GNUNET_TRANSPORT_LinkInformation::communicators, GNUNET_TRANSPORT_LinkInformation::confirmed, GNUNET_TRANSPORT_LinkListResponse::confirmed, GNUNET_TRANSPORT_LinkInformation::core_recv_window, GNUNET_TRANSPORT_LinkListResponse::core_recv_window, GNUNET_TRANSPORT_LinkInformation::distance, GNUNET_TRANSPORT_LinkListResponse::distance, GNUNET_TRANSPORT_LinkInformation::fc_retransmit_count, GNUNET_TRANSPORT_LinkListResponse::fc_retransmit_count, GNUNET_ntohll(), GNUNET_TIME_absolute_ntoh(), GNUNET_TIME_relative_ntoh(), GNUNET_TRANSPORT_LinkInformation::incoming_fc_window_size, GNUNET_TRANSPORT_LinkListResponse::incoming_fc_window_size, GNUNET_TRANSPORT_LinkInformation::incoming_fc_window_size_loss, GNUNET_TRANSPORT_LinkListResponse::incoming_fc_window_size_loss, GNUNET_TRANSPORT_LinkInformation::incoming_fc_window_size_ram, GNUNET_TRANSPORT_LinkListResponse::incoming_fc_window_size_ram, GNUNET_TRANSPORT_LinkInformation::incoming_fc_window_size_used, GNUNET_TRANSPORT_LinkListResponse::incoming_fc_window_size_used, GNUNET_TRANSPORT_LinkInformation::last_fc_rtt, GNUNET_TRANSPORT_LinkListResponse::last_fc_rtt, GNUNET_TRANSPORT_LinkInformation::last_fc_transmission, GNUNET_TRANSPORT_LinkListResponse::last_fc_transmission, llc, GNUNET_TRANSPORT_LinkInformation::num_queues, GNUNET_TRANSPORT_LinkListResponse::num_queues, GNUNET_TRANSPORT_LinkInformation::other_rtt, GNUNET_TRANSPORT_LinkListResponse::other_rtt, GNUNET_TRANSPORT_LinkInformation::outbound_fc_window_size, GNUNET_TRANSPORT_LinkListResponse::outbound_fc_window_size, GNUNET_TRANSPORT_LinkInformation::outbound_fc_window_size_used, GNUNET_TRANSPORT_LinkListResponse::outbound_fc_window_size_used, GNUNET_TRANSPORT_LinkInformation::pending, GNUNET_TRANSPORT_LinkListResponse::pending, GNUNET_TRANSPORT_LinkInformation::route, GNUNET_TRANSPORT_LinkListResponse::route, GNUNET_TRANSPORT_LinkInformation::stalled, GNUNET_TRANSPORT_LinkListResponse::stalled, and GNUNET_TRANSPORT_LinkListResponse::target.

Here is the call graph for this function:

handle_link_list_response_end()

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

static

Handle the end of a link listing.

Parameters

cls	our struct GNUNET_TRANSPORT_LinkListContext *
msg	the end message

Definition at line 427 of file transport_api_monitor.c.

{
  struct GNUNET_TRANSPORT_LinkListContext *llc = cls;
 
  (void) msg;
  link_list_done (llc);
}

References link_list_done(), llc, and msg.

Here is the call graph for this function: