gnunet-service-ats_performance.c File Reference

ats service, interaction with 'performance' API More...

#include "platform.h"
#include "gnunet-service-ats.h"
#include "gnunet-service-ats_addresses.h"
#include "gnunet-service-ats_performance.h"
#include "ats.h"

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

Go to the source code of this file.

Functions
static void	notify_client (struct GNUNET_SERVICE_Client *client, const struct GNUNET_PeerIdentity *peer, const char *plugin_name, const void *plugin_addr, size_t plugin_addr_len, int active, const struct GNUNET_ATS_Properties *prop, enum GNUNET_HELLO_AddressInfo local_address_info, struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out, struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
	Transmit the given performance information to all performance clients. More...
void	GAS_performance_notify_all_clients (const struct GNUNET_PeerIdentity *peer, const char *plugin_name, const void *plugin_addr, size_t plugin_addr_len, int active, const struct GNUNET_ATS_Properties *prop, enum GNUNET_HELLO_AddressInfo local_address_info, struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out, struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
	Transmit the given performance information to all performance clients. More...
static void	peerinfo_it (void *cls, const struct GNUNET_PeerIdentity *id, const char *plugin_name, const void *plugin_addr, size_t plugin_addr_len, int active, const struct GNUNET_ATS_Properties *prop, enum GNUNET_HELLO_AddressInfo local_address_info, struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out, struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
	Iterator for called from GAS_addresses_get_peer_info() More...
void	GAS_performance_add_client (struct GNUNET_SERVICE_Client *client, enum StartFlag flag)
	Register a new performance client. More...
void	GAS_performance_init ()
	Initialize performance subsystem. More...
void	GAS_performance_done ()
	Shutdown performance subsystem. More...

Variables
static struct GNUNET_NotificationContext *	nc_no_pic
	Context for sending messages to performance clients without PIC. More...
static struct GNUNET_NotificationContext *	nc_pic
	Context for sending messages to performance clients with PIC. More...

Detailed Description

ats service, interaction with 'performance' API

Author

Matthias Wachs

Christian Grothoff

TODO:

• simplify functions by passing a struct GNUNET_HELLO_Address

Definition in file gnunet-service-ats_performance.c.

Function Documentation

notify_client()

static void notify_client ( struct GNUNET_SERVICE_Client *  client, const struct GNUNET_PeerIdentity *  peer, const char *  plugin_name, const void *  plugin_addr, size_t  plugin_addr_len, int  active, const struct GNUNET_ATS_Properties *  prop, enum GNUNET_HELLO_AddressInfo  local_address_info, struct GNUNET_BANDWIDTH_Value32NBO  bandwidth_out, struct GNUNET_BANDWIDTH_Value32NBO  bandwidth_in  )

static

Transmit the given performance information to all performance clients.

Parameters

client	client to send to, NULL for all
peer	peer for which this is an address suggestion
plugin_name	0-termintated string specifying the transport plugin
plugin_addr	binary address for the plugin to use
plugin_addr_len	number of bytes in plugin_addr
active	GNUNET_YES if this address is actively used to maintain a connection to a peer; GNUNET_NO if the address is not actively used; GNUNET_SYSERR if this address is no longer available for ATS
prop	performance data for the address
local_address_info	information about the local flags for the address
bandwidth_out	assigned outbound bandwidth
bandwidth_in	assigned inbound bandwidth

Definition at line 66 of file gnunet-service-ats_performance.c.

{
  struct PeerInformationMessage *msg;
  size_t plugin_name_length = strlen (plugin_name) + 1;
  size_t msize =
    sizeof(struct PeerInformationMessage)
    + plugin_addr_len
    + plugin_name_length;
  char buf[msize] GNUNET_ALIGN;
  char *addrp;
 
  if (NULL != prop)
    GNUNET_break (GNUNET_NT_UNSPECIFIED != prop->scope);
  GNUNET_assert (msize < GNUNET_MAX_MESSAGE_SIZE);
  msg = (struct PeerInformationMessage *) buf;
  msg->header.size = htons (msize);
  msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION);
  msg->id = htonl (0);
  msg->peer = *peer;
  msg->address_length = htons (plugin_addr_len);
  msg->address_active = ntohl ((uint32_t) active);
  msg->plugin_name_length = htons (plugin_name_length);
  msg->bandwidth_out = bandwidth_out;
  msg->bandwidth_in = bandwidth_in;
  if (NULL != prop)
    GNUNET_ATS_properties_hton (&msg->properties,
                                prop);
  else
    memset (&msg->properties,
            0,
            sizeof(struct GNUNET_ATS_Properties));
  msg->address_local_info = htonl (local_address_info);
  addrp = (char *) &msg[1];
  GNUNET_memcpy (addrp, plugin_addr, plugin_addr_len);
  strcpy (&addrp[plugin_addr_len], plugin_name);
  if (NULL == client)
  {
    GNUNET_notification_context_broadcast (nc_pic,
                                           &msg->header,
                                           GNUNET_YES);
  }
  else
  {
    struct GNUNET_MQ_Envelope *env;
 
    env = GNUNET_MQ_msg_copy (&msg->header);
    GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (client),
                    env);
  }
}

References PeerInformationMessage::bandwidth_in, PeerInformationMessage::bandwidth_out, buf, env, GNUNET_ALIGN, GNUNET_assert, GNUNET_ATS_properties_hton(), GNUNET_break, GNUNET_MAX_MESSAGE_SIZE, GNUNET_memcpy, GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION, GNUNET_MQ_msg_copy(), GNUNET_MQ_send(), GNUNET_notification_context_broadcast(), GNUNET_NT_UNSPECIFIED, GNUNET_SERVICE_client_get_mq(), GNUNET_YES, msg, nc_pic, peer, plugin_name, PeerInformationMessage::plugin_name_length, GNUNET_ATS_Properties::scope, GNUNET_MessageHeader::size, and GNUNET_MessageHeader::type.

Referenced by GAS_performance_notify_all_clients(), and peerinfo_it().

Here is the call graph for this function:

Here is the caller graph for this function:

GAS_performance_notify_all_clients()

void GAS_performance_notify_all_clients	(	const struct GNUNET_PeerIdentity *	peer,
		const char *	plugin_name,
		const void *	plugin_addr,
		size_t	plugin_addr_len,
		int	active,
		const struct GNUNET_ATS_Properties *	prop,
		enum GNUNET_HELLO_AddressInfo	local_address_info,
		struct GNUNET_BANDWIDTH_Value32NBO	bandwidth_out,
		struct GNUNET_BANDWIDTH_Value32NBO	bandwidth_in
	)

Transmit the given performance information to all performance clients.

Parameters

peer	peer for which this is an address suggestion
plugin_name	0-termintated string specifying the transport plugin
plugin_addr	binary address for the plugin to use
plugin_addr_len	number of bytes in plugin_addr
active	GNUNET_YES if this address is actively used to maintain a connection to a peer; GNUNET_NO if the address is not actively used; GNUNET_SYSERR if this address is no longer available for ATS
prop	performance data for the address
local_address_info	information about the local flags for the address
bandwidth_out	assigned outbound bandwidth
bandwidth_in	assigned inbound bandwidth

Definition at line 145 of file gnunet-service-ats_performance.c.

{
  GNUNET_break ((NULL == prop) ||
                (GNUNET_NT_UNSPECIFIED != prop->scope));
  notify_client (NULL,
                 peer,
                 plugin_name,
                 plugin_addr,
                 plugin_addr_len,
                 active,
                 prop,
                 local_address_info,
                 bandwidth_out,
                 bandwidth_in);
  GNUNET_STATISTICS_update (GSA_stats,
                            "# performance updates given to clients",
                            1,
                            GNUNET_NO);
}

References GNUNET_break, GNUNET_NO, GNUNET_NT_UNSPECIFIED, GNUNET_STATISTICS_update(), GSA_stats, notify_client(), peer, plugin_name, and GNUNET_ATS_Properties::scope.

Referenced by bandwidth_changed_cb(), free_address(), GAS_addresses_add(), and GAS_addresses_update().

Here is the call graph for this function:

Here is the caller graph for this function:

peerinfo_it()

static void peerinfo_it ( void *  cls, const struct GNUNET_PeerIdentity *  id, const char *  plugin_name, const void *  plugin_addr, size_t  plugin_addr_len, int  active, const struct GNUNET_ATS_Properties *  prop, enum GNUNET_HELLO_AddressInfo  local_address_info, struct GNUNET_BANDWIDTH_Value32NBO  bandwidth_out, struct GNUNET_BANDWIDTH_Value32NBO  bandwidth_in  )

static

Iterator for called from GAS_addresses_get_peer_info()

Parameters

cls	closure with the struct GNUNET_SERVICE_Client * to inform.
id	the peer id
plugin_name	plugin name
plugin_addr	address
plugin_addr_len	length of plugin_addr
active	is address actively used
prop	performance information
local_address_info	information about the local flags for the address
bandwidth_out	current outbound bandwidth assigned to address
bandwidth_in	current inbound bandwidth assigned to address

Definition at line 192 of file gnunet-service-ats_performance.c.

{
  struct GNUNET_SERVICE_Client *client = cls;
 
  if (NULL == id)
    return;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Callback for peer `%s' plugin `%s' BW out %u, BW in %u \n",
              GNUNET_i2s (id),
              plugin_name,
              (unsigned int) ntohl (bandwidth_out.value__),
              (unsigned int) ntohl (bandwidth_in.value__));
  GNUNET_break (GNUNET_NT_UNSPECIFIED != prop->scope);
  notify_client (client,
                 id,
                 plugin_name,
                 plugin_addr,
                 plugin_addr_len,
                 active,
                 prop,
                 local_address_info,
                 bandwidth_out,
                 bandwidth_in);
}

References GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_log, GNUNET_NT_UNSPECIFIED, notify_client(), plugin_name, GNUNET_ATS_Properties::scope, and GNUNET_BANDWIDTH_Value32NBO::value__.

Referenced by GAS_performance_add_client().

Here is the call graph for this function:

Here is the caller graph for this function:

GAS_performance_add_client()

void GAS_performance_add_client	(	struct GNUNET_SERVICE_Client *	client,
		enum StartFlag	flag
	)

Register a new performance client.

Parameters

client	handle of the new client
flag	flag specifying the type of the client

Definition at line 234 of file gnunet-service-ats_performance.c.

{
  struct GNUNET_MQ_Handle *mq;
 
  mq = GNUNET_SERVICE_client_get_mq (client);
  if (START_FLAG_PERFORMANCE_WITH_PIC == flag)
  {
    GNUNET_notification_context_add (nc_pic,
                                     mq);
    GAS_addresses_get_peer_info (NULL,
                                 &peerinfo_it,
                                 client);
  }
  else
  {
    GNUNET_notification_context_add (nc_no_pic,
                                     mq);
  }
}

References GAS_addresses_get_peer_info(), GNUNET_notification_context_add(), GNUNET_SERVICE_client_get_mq(), mq, nc_no_pic, nc_pic, peerinfo_it(), and START_FLAG_PERFORMANCE_WITH_PIC.

Referenced by handle_ats_start().

Here is the call graph for this function:

Here is the caller graph for this function:

GAS_performance_init()

void GAS_performance_init

(

void

)

Initialize performance subsystem.

Parameters

server

handle to our server

Definition at line 262 of file gnunet-service-ats_performance.c.

{
  nc_no_pic = GNUNET_notification_context_create (32);
  nc_pic = GNUNET_notification_context_create (32);
}

References GNUNET_notification_context_create(), nc_no_pic, and nc_pic.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

GAS_performance_done()

void GAS_performance_done

(

void

)

Shutdown performance subsystem.

Definition at line 273 of file gnunet-service-ats_performance.c.

{
  GNUNET_notification_context_destroy (nc_no_pic);
  nc_no_pic = NULL;
  GNUNET_notification_context_destroy (nc_pic);
  nc_pic = NULL;
}

References GNUNET_notification_context_destroy(), nc_no_pic, and nc_pic.

Referenced by cleanup_task().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

nc_no_pic

struct GNUNET_NotificationContext* nc_no_pic

static

Context for sending messages to performance clients without PIC.

Definition at line 39 of file gnunet-service-ats_performance.c.

Referenced by GAS_performance_add_client(), GAS_performance_done(), and GAS_performance_init().

nc_pic

struct GNUNET_NotificationContext* nc_pic

static

Context for sending messages to performance clients with PIC.

Definition at line 44 of file gnunet-service-ats_performance.c.

Referenced by GAS_performance_add_client(), GAS_performance_done(), GAS_performance_init(), and notify_client().