ats_api_performance.c File Reference

automatic transport selection and outbound bandwidth determination More...

#include "platform.h"
#include "gnunet_ats_service.h"
#include "ats.h"

Include dependency graph for ats_api_performance.c:

Go to the source code of this file.

Data Structures
struct	GNUNET_ATS_ReservationContext
	Linked list of pending reservations. More...
struct	GNUNET_ATS_AddressListHandle
	Linked list of pending reservations. More...
struct	GNUNET_ATS_PerformanceHandle
	ATS Handle to obtain and/or modify performance information. More...

Macros
#define	LOG(kind, ...)

Functions
static void	reconnect (struct GNUNET_ATS_PerformanceHandle *ph)
	Re-establish the connection to the ATS service. More...
static void	reconnect_task (void *cls)
	Re-establish the connection to the ATS service. More...
static void	do_reconnect (struct GNUNET_ATS_PerformanceHandle *ph)
	Reconnect to the ATS service, something went wrong. More...
static int	check_peer_information (void *cls, const struct PeerInformationMessage *pi)
	We received a peer information message. More...
static void	handle_peer_information (void *cls, const struct PeerInformationMessage *pi)
	We received a peer information message. More...
static void	handle_reservation_result (void *cls, const struct ReservationResultMessage *rr)
	We received a reservation result message. More...
static int	check_address_list (void *cls, const struct PeerInformationMessage *pi)
	We received a PeerInformationMessage. More...
static void	handle_address_list (void *cls, const struct PeerInformationMessage *pi)
	We received a GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_RESPONSE. 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_ATS_PerformanceHandle *	GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_ATS_AddressInformationCallback addr_info_cb, void *addr_info_cb_cls)
	Get handle to access performance API of the ATS subsystem. More...
void	GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph)
	Client is done using the ATS performance subsystem, release resources. More...
struct GNUNET_ATS_ReservationContext *	GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph, const struct GNUNET_PeerIdentity *peer, int32_t amount, GNUNET_ATS_ReservationCallback rcb, void *rcb_cls)
	Reserve inbound bandwidth from the given peer. More...
void	GNUNET_ATS_reserve_bandwidth_cancel (struct GNUNET_ATS_ReservationContext *rc)
	Cancel request for reserving bandwidth. More...
struct GNUNET_ATS_AddressListHandle *	GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *ph, const struct GNUNET_PeerIdentity *peer, int all, GNUNET_ATS_AddressInformationCallback infocb, void *infocb_cls)
	Get information about addresses known to the ATS subsystem. More...
void	GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandle *alh)
	Cancel a pending address listing operation. More...
const char *	GNUNET_ATS_print_preference_type (enum GNUNET_ATS_PreferenceKind type)
	Convert an enum GNUNET_ATS_PreferenceType to a string. More...
void	GNUNET_ATS_performance_change_preference (struct GNUNET_ATS_PerformanceHandle *ph, const struct GNUNET_PeerIdentity *peer,...)
	Change preferences for the given peer. More...
void	GNUNET_ATS_performance_give_feedback (struct GNUNET_ATS_PerformanceHandle *ph, const struct GNUNET_PeerIdentity *peer, const struct GNUNET_TIME_Relative scope,...)
	Send feedback to ATS on how good a the requirements for a peer and a preference is satisfied by ATS. More...

Detailed Description

automatic transport selection and outbound bandwidth determination

Author

Christian Grothoff

Matthias Wachs

Definition in file ats_api_performance.c.

Macro Definition Documentation

LOG

#define LOG	(		kind,
			...
	)

Value:

                                        GNUNET_log_from (kind, "ats-performance-api", \
                                        __VA_ARGS__)

Definition at line 31 of file ats_api_performance.c.

Function Documentation

reconnect()

static void reconnect ( struct GNUNET_ATS_PerformanceHandle *  ph )

static

Re-establish the connection to the ATS service.

Parameters

ph	handle to use to re-connect.

Definition at line 565 of file ats_api_performance.c.

{
  struct GNUNET_MQ_MessageHandler handlers[] = {
    GNUNET_MQ_hd_var_size (peer_information,
                           GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION,
                           struct PeerInformationMessage,
                           ph),
    GNUNET_MQ_hd_fixed_size (reservation_result,
                             GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT,
                             struct ReservationResultMessage,
                             ph),
    GNUNET_MQ_hd_var_size (address_list,
                           GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_RESPONSE,
                           struct PeerInformationMessage,
                           ph),
    GNUNET_MQ_handler_end ()
  };
  struct GNUNET_MQ_Envelope *env;
  struct ClientStartMessage *init;
 
  GNUNET_assert (NULL == ph->mq);
  ph->mq = GNUNET_CLIENT_connect (ph->cfg,
                                  "ats",
                                  handlers,
                                  &mq_error_handler,
                                  ph);
  if (NULL == ph->mq)
    return;
  env = GNUNET_MQ_msg (init,
                       GNUNET_MESSAGE_TYPE_ATS_START);
  init->start_flag = htonl ((NULL == ph->addr_info_cb)
                            ? START_FLAG_PERFORMANCE_NO_PIC
                            : START_FLAG_PERFORMANCE_WITH_PIC);
  GNUNET_MQ_send (ph->mq,
                  env);
}

References GNUNET_ATS_PerformanceHandle::addr_info_cb, GNUNET_ATS_PerformanceHandle::cfg, env, GNUNET_assert, GNUNET_CLIENT_connect(), GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_RESPONSE, GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION, GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT, GNUNET_MESSAGE_TYPE_ATS_START, GNUNET_MQ_handler_end, GNUNET_MQ_hd_fixed_size, GNUNET_MQ_hd_var_size, GNUNET_MQ_msg, GNUNET_MQ_send(), handlers, init, GNUNET_ATS_PerformanceHandle::mq, mq_error_handler(), ph, START_FLAG_PERFORMANCE_NO_PIC, and START_FLAG_PERFORMANCE_WITH_PIC.

Referenced by GNUNET_ATS_performance_init(), handle_reservation_result(), and reconnect_task().

Here is the call graph for this function:

Here is the caller graph for this function:

reconnect_task()

static void reconnect_task ( void *  cls )

static

Re-establish the connection to the ATS service.

Parameters

cls	handle to use to re-connect.

Definition at line 225 of file ats_api_performance.c.

{
  struct GNUNET_ATS_PerformanceHandle *ph = cls;
 
  ph->task = NULL;
  reconnect (ph);
}

References ph, reconnect(), and GNUNET_ATS_PerformanceHandle::task.

Referenced by do_reconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

do_reconnect()

static void do_reconnect ( struct GNUNET_ATS_PerformanceHandle *  ph )

static

Reconnect to the ATS service, something went wrong.

Parameters

ph	handle to reconnect

Definition at line 240 of file ats_api_performance.c.

{
  struct GNUNET_ATS_ReservationContext *rc;
  struct GNUNET_ATS_AddressListHandle *alh;
  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_zero;
 
  if (NULL != ph->mq)
  {
    GNUNET_MQ_destroy (ph->mq);
    ph->mq = NULL;
  }
  while (NULL != (rc = ph->reservation_head))
  {
    GNUNET_CONTAINER_DLL_remove (ph->reservation_head,
                                 ph->reservation_tail,
                                 rc);
    if (NULL != rc->rcb)
      rc->rcb (rc->rcb_cls,
               NULL,
               0,
               GNUNET_TIME_UNIT_FOREVER_REL);
    GNUNET_free (rc);
  }
  bandwidth_zero.value__ = htonl (0);
  while (NULL != (alh = ph->addresslist_head))
  {
    GNUNET_CONTAINER_DLL_remove (ph->addresslist_head,
                                 ph->addresslist_tail,
                                 alh);
    if (NULL != alh->cb)
      alh->cb (alh->cb_cls,
               NULL,
               GNUNET_NO,
               bandwidth_zero,
               bandwidth_zero,
               NULL);
    GNUNET_free (alh);
  }
  if (NULL != ph->addr_info_cb)
  {
    /* Indicate reconnect */
    ph->addr_info_cb (ph->addr_info_cb_cls,
                      NULL,
                      GNUNET_NO,
                      bandwidth_zero,
                      bandwidth_zero,
                      NULL);
  }
  ph->backoff = GNUNET_TIME_STD_BACKOFF (ph->backoff);
  ph->task = GNUNET_SCHEDULER_add_delayed (ph->backoff,
                                           &reconnect_task,
                                           ph);
}

References GNUNET_ATS_PerformanceHandle::addr_info_cb, GNUNET_ATS_PerformanceHandle::addr_info_cb_cls, GNUNET_ATS_PerformanceHandle::addresslist_head, GNUNET_ATS_PerformanceHandle::addresslist_tail, alh, GNUNET_ATS_PerformanceHandle::backoff, GNUNET_ATS_AddressListHandle::cb, GNUNET_ATS_AddressListHandle::cb_cls, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_MQ_destroy(), GNUNET_NO, GNUNET_SCHEDULER_add_delayed(), GNUNET_TIME_STD_BACKOFF, GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_ATS_PerformanceHandle::mq, ph, GNUNET_ATS_ReservationContext::rcb, GNUNET_ATS_ReservationContext::rcb_cls, reconnect_task(), GNUNET_ATS_PerformanceHandle::reservation_head, GNUNET_ATS_PerformanceHandle::reservation_tail, GNUNET_ATS_PerformanceHandle::task, and GNUNET_BANDWIDTH_Value32NBO::value__.

Referenced by mq_error_handler().

Here is the call graph for this function:

Here is the caller graph for this function:

check_peer_information()

static int check_peer_information ( void *  cls, const struct PeerInformationMessage *  pi  )

static

We received a peer information message.

Validate and process it.

Parameters

cls	our context with the callback
pi	the message

Returns

GNUNET_OK if the message was well-formed

Definition at line 303 of file ats_api_performance.c.

{
  const char *plugin_address;
  const char *plugin_name;
  uint16_t plugin_address_length;
  uint16_t plugin_name_length;
 
  plugin_address_length = ntohs (pi->address_length);
  plugin_name_length = ntohs (pi->plugin_name_length);
  plugin_address = (const char *) &pi[1];
  plugin_name = &plugin_address[plugin_address_length];
  if ((plugin_address_length + plugin_name_length
       + sizeof(struct PeerInformationMessage) != ntohs (pi->header.size)) ||
      (plugin_name[plugin_name_length - 1] != '\0'))
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

References GNUNET_break, GNUNET_OK, GNUNET_SYSERR, pi, and plugin_name.

handle_peer_information()

static void handle_peer_information ( void *  cls, const struct PeerInformationMessage *  pi  )

static

We received a peer information message.

Validate and process it.

Parameters

cls	our context with the callback
pi	the message

Returns

GNUNET_OK if the message was well-formed

Definition at line 334 of file ats_api_performance.c.

{
  struct GNUNET_ATS_PerformanceHandle *ph = cls;
  const char *plugin_address;
  const char *plugin_name;
  struct GNUNET_HELLO_Address address;
  uint16_t plugin_address_length;
  int addr_active;
  struct GNUNET_ATS_Properties prop;
 
  if (NULL == ph->addr_info_cb)
    return;
  plugin_address_length = ntohs (pi->address_length);
  addr_active = (int) ntohl (pi->address_active);
  plugin_address = (const char *) &pi[1];
  plugin_name = &plugin_address[plugin_address_length];
 
  GNUNET_ATS_properties_ntoh (&prop,
                              &pi->properties);
  address.peer = pi->peer;
  address.local_info = (enum GNUNET_HELLO_AddressInfo) ntohl (
    pi->address_local_info);
  address.address = plugin_address;
  address.address_length = plugin_address_length;
  address.transport_name = plugin_name;
  ph->addr_info_cb (ph->addr_info_cb_cls,
                    &address,
                    addr_active,
                    pi->bandwidth_out,
                    pi->bandwidth_in,
                    &prop);
}

References GNUNET_ATS_PerformanceHandle::addr_info_cb, GNUNET_ATS_PerformanceHandle::addr_info_cb_cls, address, GNUNET_ATS_properties_ntoh(), consensus-simulation::int, ph, pi, and plugin_name.

Here is the call graph for this function:

handle_reservation_result()

static void handle_reservation_result ( void *  cls, const struct ReservationResultMessage *  rr  )

static

We received a reservation result message.

Validate and process it.

Parameters

cls	our context with the callback
rr	the message

Definition at line 376 of file ats_api_performance.c.

{
  struct GNUNET_ATS_PerformanceHandle *ph = cls;
  struct GNUNET_ATS_ReservationContext *rc;
  int32_t amount;
 
  amount = ntohl (rr->amount);
  rc = ph->reservation_head;
  if (0 != GNUNET_memcmp (&rr->peer,
                          &rc->peer))
  {
    GNUNET_break (0);
    reconnect (ph);
    return;
  }
  GNUNET_CONTAINER_DLL_remove (ph->reservation_head,
                               ph->reservation_tail,
                               rc);
  if ((0 == amount) ||
      (NULL != rc->rcb))
  {
    /* tell client if not cancelled */
    if (NULL != rc->rcb)
      rc->rcb (rc->rcb_cls,
               &rr->peer,
               amount,
               GNUNET_TIME_relative_ntoh (rr->res_delay));
    GNUNET_free (rc);
    return;
  }
  /* amount non-zero, but client cancelled, consider undo! */
  if (GNUNET_YES != rc->undo)
  {
    GNUNET_free (rc);
    return;   /* do not try to undo failed undos or negative amounts */
  }
  GNUNET_free (rc);
  (void) GNUNET_ATS_reserve_bandwidth (ph,
                                       &rr->peer,
                                       -amount,
                                       NULL, NULL);
}

References ReservationResultMessage::amount, GNUNET_ATS_reserve_bandwidth(), GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_memcmp, GNUNET_TIME_relative_ntoh(), GNUNET_YES, ReservationResultMessage::peer, GNUNET_ATS_ReservationContext::peer, ph, GNUNET_ATS_ReservationContext::rcb, GNUNET_ATS_ReservationContext::rcb_cls, reconnect(), ReservationResultMessage::res_delay, GNUNET_ATS_PerformanceHandle::reservation_head, GNUNET_ATS_PerformanceHandle::reservation_tail, and GNUNET_ATS_ReservationContext::undo.

Here is the call graph for this function:

check_address_list()

static int check_address_list ( void *  cls, const struct PeerInformationMessage *  pi  )

static

We received a PeerInformationMessage.

Validate it.

Parameters

cls	our context with the callback
pi	the message

Returns

GNUNET_OK if the message was well-formed

Definition at line 429 of file ats_api_performance.c.

{
  const char *plugin_address;
  const char *plugin_name;
  uint16_t plugin_address_length;
  uint16_t plugin_name_length;
 
  plugin_address_length = ntohs (pi->address_length);
  plugin_name_length = ntohs (pi->plugin_name_length);
  plugin_address = (const char *) &pi[1];
  plugin_name = &plugin_address[plugin_address_length];
  if ((plugin_address_length + plugin_name_length
       + sizeof(struct PeerInformationMessage) != ntohs (pi->header.size)) ||
      (plugin_name[plugin_name_length - 1] != '\0'))
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

References GNUNET_break, GNUNET_OK, GNUNET_SYSERR, pi, and plugin_name.

handle_address_list()

static void handle_address_list ( void *  cls, const struct PeerInformationMessage *  pi  )

static

We received a GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_RESPONSE.

Process it.

Parameters

cls	our context with the callback
pi	the message

Definition at line 460 of file ats_api_performance.c.

{
  struct GNUNET_ATS_PerformanceHandle *ph = cls;
  struct GNUNET_ATS_AddressListHandle *alh;
  struct GNUNET_ATS_AddressListHandle *next;
  const char *plugin_address;
  const char *plugin_name;
  struct GNUNET_HELLO_Address address;
  struct GNUNET_PeerIdentity allzeros;
  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_zero;
  struct GNUNET_ATS_Properties prop;
  uint16_t plugin_address_length;
  uint16_t plugin_name_length;
  uint32_t active;
  uint32_t id;
 
  id = ntohl (pi->id);
  active = ntohl (pi->address_active);
  plugin_address_length = ntohs (pi->address_length);
  plugin_name_length = ntohs (pi->plugin_name_length);
  plugin_address = (const char *) &pi[1];
  plugin_name = &plugin_address[plugin_address_length];
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Received ATS_ADDRESSLIST_RESPONSE message for peer %s and plugin %s\n",
       GNUNET_i2s (&pi->peer),
       plugin_name);
 
  next = ph->addresslist_head;
  while (NULL != (alh = next))
  {
    next = alh->next;
    if (alh->id == id)
      break;
  }
  if (NULL == alh)
    return; /* was canceled */
 
  memset (&allzeros, '\0', sizeof(allzeros));
  if ((GNUNET_YES == GNUNET_is_zero (&pi->peer)) &&
      (0 == plugin_name_length) &&
      (0 == plugin_address_length))
  {
    /* Done */
    LOG (GNUNET_ERROR_TYPE_DEBUG,
         "Received last message for ATS_ADDRESSLIST_RESPONSE\n");
    bandwidth_zero.value__ = htonl (0);
    GNUNET_CONTAINER_DLL_remove (ph->addresslist_head,
                                 ph->addresslist_tail,
                                 alh);
    if (NULL != alh->cb)
      alh->cb (alh->cb_cls,
               NULL,
               GNUNET_NO,
               bandwidth_zero,
               bandwidth_zero,
               NULL);
    GNUNET_free (alh);
    return;
  }
 
  address.peer = pi->peer;
  address.address = plugin_address;
  address.address_length = plugin_address_length;
  address.transport_name = plugin_name;
  if (((GNUNET_YES == alh->all_addresses) ||
       (GNUNET_YES == active)) &&
      (NULL != alh->cb))
  {
    GNUNET_ATS_properties_ntoh (&prop,
                                &pi->properties);
    alh->cb (alh->cb_cls,
             &address,
             active,
             pi->bandwidth_out,
             pi->bandwidth_in,
             &prop);
  }
}

References address, GNUNET_ATS_PerformanceHandle::addresslist_head, GNUNET_ATS_PerformanceHandle::addresslist_tail, alh, GNUNET_ATS_AddressListHandle::all_addresses, GNUNET_ATS_AddressListHandle::cb, GNUNET_ATS_AddressListHandle::cb_cls, GNUNET_ATS_properties_ntoh(), GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_i2s(), GNUNET_is_zero, GNUNET_NO, GNUNET_YES, GNUNET_ATS_AddressListHandle::id, id, LOG, GNUNET_ATS_AddressListHandle::next, ph, pi, plugin_name, and GNUNET_BANDWIDTH_Value32NBO::value__.

Here is the call graph for this function:

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_ATS_PerformanceHandle *
error	error code

Definition at line 550 of file ats_api_performance.c.

{
  struct GNUNET_ATS_PerformanceHandle *ph = cls;
 
  do_reconnect (ph);
}

References do_reconnect(), and ph.

Referenced by reconnect().

Here is the call graph for this function:

Here is the caller graph for this function: