gnunet-service-ats_normalization.c File Reference

ats service address: management of ATS properties and preferences normalization More...

#include "platform.h"
#include <float.h>
#include "gnunet_ats_service.h"
#include "gnunet-service-ats_addresses.h"
#include "gnunet-service-ats_normalization.h"
#include "gnunet-service-ats_plugins.h"

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

Go to the source code of this file.

Data Structures
struct	PropertyRange
	Range information for normalization of quality properties. More...

Macros
#define	LOG(kind, ...)   GNUNET_log_from (kind, "ats-normalization", __VA_ARGS__)

Functions
static void	update_avg (uint64_t current_val, struct GAS_NormalizationInfo *ni)
	Add the value from atsi to the running average of the given ni quality property. More...
static int	find_min_max_it (void *cls, const struct GNUNET_PeerIdentity *h, void *k)
	Function called for all addresses and peers to find the minimum and maximum (averaged) values for a given quality property. More...
static void	update_norm (uint64_t min, uint64_t max, struct GAS_NormalizationInfo *ni)
	Compute the normalized value from the given ni range data and the average value. More...
static int	normalize_address (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
	Normalize the property value for a given address based on the range we know that property values have globally. More...
static int	notify_change (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
	Notify about change in normalized property. More...
static void	init_range (struct PropertyRange *pr)
	Initialize property range to the values corresponding to an empty set. More...
void	GAS_normalization_update_property (struct ATS_Address *address)
	Update and normalize atsi performance information. More...
void	GAS_normalization_start ()
	Start the normalization component. More...
void	GAS_normalization_stop ()
	Stop the normalization component and free all items. More...

Variables
static struct PropertyRange	property_range
	Range information for all quality properties we see. More...

Detailed Description

ats service address: management of ATS properties and preferences normalization

Author

Matthias Wachs

Christian Grothoff

Definition in file gnunet-service-ats_normalization.c.

Macro Definition Documentation

LOG

#define LOG	(		kind,
			...
	)		GNUNET_log_from (kind, "ats-normalization", __VA_ARGS__)

Definition at line 34 of file gnunet-service-ats_normalization.c.

Function Documentation

update_avg()

static void update_avg ( uint64_t  current_val, struct GAS_NormalizationInfo *  ni  )

static

Add the value from atsi to the running average of the given ni quality property.

Parameters

current_val	the updated value
ni	normalization information to update

Definition at line 68 of file gnunet-service-ats_normalization.c.

{
  double sum;
  uint32_t count;
  unsigned int c1;
 
  ni->atsi_abs[ni->avg_queue_index++] = current_val;
  if (GAS_normalization_queue_length == ni->avg_queue_index)
    ni->avg_queue_index = 0;
  count = 0;
  sum = 0.0;
  for (c1 = 0; c1 < GAS_normalization_queue_length; c1++)
  {
    if (UINT64_MAX != ni->atsi_abs[c1])
    {
      count++;
      sum += (double) ni->atsi_abs[c1];
    }
  }
  if (0 == count)
    ni->avg = current_val; /* must be UINT64_MAX */
  else
    ni->avg = sum / count;
}

References GAS_NormalizationInfo::atsi_abs, GAS_NormalizationInfo::avg, GAS_NormalizationInfo::avg_queue_index, GAS_normalization_queue_length, and consensus-simulation::sum.

Referenced by GAS_normalization_update_property().

Here is the caller graph for this function:

find_min_max_it()

static int find_min_max_it ( void *  cls, const struct GNUNET_PeerIdentity *  h, void *  k  )

static

Function called for all addresses and peers to find the minimum and maximum (averaged) values for a given quality property.

Given those, we can then calculate the normalized score.

Parameters

cls	the struct PropertyRange
h	which peer are we looking at (ignored)
k	the address for that peer

Returns

GNUNET_OK (continue to iterate)

Definition at line 106 of file gnunet-service-ats_normalization.c.

{
  struct PropertyRange *pr = cls;
  const struct ATS_Address *a = k;
 
  pr->max.utilization_out = GNUNET_MAX (pr->max.utilization_out,
                                        a->properties.utilization_out);
  pr->max.utilization_in = GNUNET_MAX (pr->max.utilization_in,
                                       a->properties.utilization_in);
  pr->max.distance = GNUNET_MAX (pr->max.distance,
                                 a->properties.distance);
  pr->max.delay = GNUNET_TIME_relative_max (pr->max.delay,
                                            a->properties.delay);
  pr->min.utilization_out = GNUNET_MIN (pr->min.utilization_out,
                                        a->properties.utilization_out);
  pr->min.utilization_in = GNUNET_MIN (pr->min.utilization_in,
                                       a->properties.utilization_in);
  pr->min.distance = GNUNET_MIN (pr->min.distance,
                                 a->properties.distance);
  pr->min.delay = GNUNET_TIME_relative_min (pr->min.delay,
                                            a->properties.delay);
  return GNUNET_OK;
}

References GNUNET_ATS_Properties::delay, GNUNET_ATS_Properties::distance, GNUNET_MAX, GNUNET_MIN, GNUNET_OK, GNUNET_TIME_relative_max(), GNUNET_TIME_relative_min(), PropertyRange::max, PropertyRange::min, ATS_Address::properties, GNUNET_ATS_Properties::utilization_in, and GNUNET_ATS_Properties::utilization_out.

Referenced by GAS_normalization_update_property().

Here is the call graph for this function:

Here is the caller graph for this function:

update_norm()

static void update_norm ( uint64_t  min, uint64_t  max, struct GAS_NormalizationInfo *  ni  )

static

Compute the normalized value from the given ni range data and the average value.

Parameters

min	minimum value
max	maximum value
ni	normalization information to update

Definition at line 142 of file gnunet-service-ats_normalization.c.

{
  /* max - 2 * min + avg_value / (max - min) */
  if (min < max)
    ni->norm = DEFAULT_REL_QUALITY + (ni->avg - min) / (double) (max - min);
  else
    ni->norm = DEFAULT_REL_QUALITY;
}

References GAS_NormalizationInfo::avg, DEFAULT_REL_QUALITY, max, min, and GAS_NormalizationInfo::norm.

Referenced by normalize_address().

Here is the caller graph for this function:

normalize_address()

static int normalize_address ( void *  cls, const struct GNUNET_PeerIdentity *  key, void *  value  )

static

Normalize the property value for a given address based on the range we know that property values have globally.

Parameters

cls	NULL
key	which peer are we looking at (ignored)
value	the address for that peer, from where we get the original value and where we write the normalized value

Returns

GNUNET_OK (continue to iterate)

Definition at line 166 of file gnunet-service-ats_normalization.c.

{
  struct ATS_Address *address = value;
 
  update_norm (property_range.min.delay.rel_value_us,
               property_range.max.delay.rel_value_us,
               &address->norm_delay);
  update_norm (property_range.min.distance,
               property_range.max.distance,
               &address->norm_distance);
  update_norm (property_range.min.utilization_in,
               property_range.max.utilization_in,
               &address->norm_utilization_in);
  update_norm (property_range.min.utilization_out,
               property_range.max.utilization_out,
               &address->norm_utilization_out);
  return GNUNET_OK;
}

References address, GNUNET_ATS_Properties::delay, GNUNET_ATS_Properties::distance, GNUNET_OK, PropertyRange::max, PropertyRange::min, property_range, GNUNET_TIME_Relative::rel_value_us, update_norm(), GNUNET_ATS_Properties::utilization_in, GNUNET_ATS_Properties::utilization_out, and value.

Referenced by GAS_normalization_update_property().

Here is the call graph for this function:

Here is the caller graph for this function:

notify_change()

static int notify_change ( void *  cls, const struct GNUNET_PeerIdentity *  key, void *  value  )

static

Notify about change in normalized property.

Parameters

cls	NULL
key	which peer are we looking at (ignored)
value	the address for that peer

Returns

GNUNET_OK (continue to iterate)

Definition at line 197 of file gnunet-service-ats_normalization.c.

{
  struct ATS_Address *address = value;
 
  GAS_plugin_notify_property_changed (address);
  return GNUNET_OK;
}

References address, GAS_plugin_notify_property_changed(), GNUNET_OK, and value.

Referenced by GAS_normalization_update_property().

Here is the call graph for this function:

Here is the caller graph for this function:

init_range()

static void init_range ( struct PropertyRange *  pr )

static

Initialize property range to the values corresponding to an empty set.

Parameters

pr	range to initialize

Definition at line 215 of file gnunet-service-ats_normalization.c.

{
  memset (pr, 0, sizeof(struct PropertyRange));
  pr->min.utilization_out = UINT32_MAX;
  pr->min.utilization_in = UINT32_MAX;
  pr->min.distance = UINT32_MAX;
  pr->min.delay = GNUNET_TIME_UNIT_FOREVER_REL;
}

References GNUNET_ATS_Properties::delay, GNUNET_ATS_Properties::distance, GNUNET_TIME_UNIT_FOREVER_REL, PropertyRange::min, GNUNET_ATS_Properties::utilization_in, and GNUNET_ATS_Properties::utilization_out.

Referenced by GAS_normalization_start(), and GAS_normalization_update_property().

Here is the caller graph for this function:

GAS_normalization_update_property()

void GAS_normalization_update_property

(

struct ATS_Address *

address

)

Update and normalize atsi performance information.

Update and normalize a prop performance information.

Parameters

address

the address to update

Definition at line 231 of file gnunet-service-ats_normalization.c.

{
  const struct GNUNET_ATS_Properties *prop = &address->properties;
  struct PropertyRange range;
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Updating properties for peer `%s'\n",
       GNUNET_i2s (&address->peer));
  GAS_plugin_solver_lock ();
  update_avg (prop->delay.rel_value_us,
              &address->norm_delay);
  update_avg (prop->distance,
              &address->norm_distance);
  update_avg (prop->utilization_in,
              &address->norm_utilization_in);
  update_avg (prop->utilization_in,
              &address->norm_utilization_out);
 
  init_range (&range);
  GNUNET_CONTAINER_multipeermap_iterate (GSA_addresses,
                                         &find_min_max_it,
                                         &range);
  if (0 != GNUNET_memcmp (&range,
                          &property_range))
  {
    /* limits changed, (re)normalize all addresses */
    property_range = range;
    GNUNET_CONTAINER_multipeermap_iterate (GSA_addresses,
                                           &normalize_address,
                                           NULL);
    GNUNET_CONTAINER_multipeermap_iterate (GSA_addresses,
                                           &notify_change,
                                           NULL);
  }
  else
  {
    /* renormalize just this one address */
    normalize_address (NULL,
                       &address->peer,
                       address);
    notify_change (NULL,
                   &address->peer,
                   address);
  }
  GAS_plugin_solver_unlock ();
}

References address, GNUNET_ATS_Properties::delay, GNUNET_ATS_Properties::distance, find_min_max_it(), GAS_plugin_solver_lock(), GAS_plugin_solver_unlock(), GNUNET_CONTAINER_multipeermap_iterate(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_memcmp, GSA_addresses, init_range(), LOG, normalize_address(), notify_change(), property_range, GNUNET_TIME_Relative::rel_value_us, update_avg(), and GNUNET_ATS_Properties::utilization_in.

Referenced by GAS_addresses_add(), GAS_addresses_update(), and set_prop_task().

Here is the call graph for this function:

Here is the caller graph for this function:

GAS_normalization_start()

void GAS_normalization_start

(

void

)

Start the normalization component.

Definition at line 283 of file gnunet-service-ats_normalization.c.

{
  init_range (&property_range);
}

References init_range(), and property_range.

Referenced by GNUNET_ATS_solvers_solver_start(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

GAS_normalization_stop()

void GAS_normalization_stop

(

void

)

Stop the normalization component and free all items.

Definition at line 293 of file gnunet-service-ats_normalization.c.

{
  /* nothing to do */
}

Referenced by cleanup_task(), GNUNET_ATS_solvers_solver_stop(), and run().

Here is the caller graph for this function:

Variable Documentation

property_range

struct PropertyRange property_range

static

Range information for all quality properties we see.

Definition at line 1 of file gnunet-service-ats_normalization.c.

Referenced by GAS_normalization_start(), GAS_normalization_update_property(), and normalize_address().