src/ats/gnunet-service-ats_normalization.c

   1 /*
   2  This file is part of GNUnet.
   3  (C) 2011 Christian Grothoff (and other contributing authors)
   4
   5  GNUnet is free software; you can redistribute it and/or modify
   6  it under the terms of the GNU General Public License as published
   7  by the Free Software Foundation; either version 3, or (at your
   8  option) any later version.
   9
  10  GNUnet is distributed in the hope that it will be useful, but
  11  WITHOUT ANY WARRANTY; without even the implied warranty of
  12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  General Public License for more details.
  14
  15  You should have received a copy of the GNU General Public License
  16  along with GNUnet; see the file COPYING.  If not, write to the
  17  Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  Boston, MA 02111-1307, USA.
  19  */
  20
  21 /**
  22  * @file ats/gnunet-service-ats_normalization.c
  23  * @brief ats service address: management of ATS properties and preferences normalization
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #include "platform.h"
  28 #include "gnunet_ats_service.h"
  29 #include "gnunet-service-ats_addresses.h"
  30 #include "gnunet-service-ats_normalization.h"
  31
  32 #define LOG(kind,...) GNUNET_log_from (kind, "ats-normalization",__VA_ARGS__)
  33
  34 /**
  35  * Preference client
  36  */
  37 struct PreferenceClient
  38 {
  39   /**
  40    * Next in DLL
  41    */
  42   struct PreferenceClient *prev;
  43
  44   /**
  45    * Next in DLL
  46    */
  47
  48   struct PreferenceClient *next;
  49
  50   /**
  51    * Client handle
  52    */
  53   void *client;
  54
  55   /**
  56    * Total preference for this peer
  57    */
  58   double f_abs_sum[GNUNET_ATS_PreferenceCount];
  59
  60   /**
  61    * List of peer preferences for this client
  62    */
  63
  64   /**
  65    * Head of peer list
  66    */
  67   struct PreferencePeer *p_head;
  68
  69   /**
  70    * Tail of peer list
  71    */
  72   struct PreferencePeer *p_tail;
  73 };
  74
  75 /**
  76  * Preference peer
  77  */
  78 struct PreferencePeer
  79 {
  80   /**
  81    * Next in DLL
  82    */
  83   struct PreferencePeer *next;
  84
  85   /**
  86    * Previous in DLL
  87    */
  88   struct PreferencePeer *prev;
  89
  90   /**
  91    * Client
  92    */
  93   struct PreferenceClient *client;
  94
  95   /**
  96    * Peer id
  97    */
  98   struct GNUNET_PeerIdentity id;
  99
 100   /**
 101    * Absolute preference values
 102    */
 103   double f_abs[GNUNET_ATS_PreferenceCount];
 104
 105   /**
 106    * Relative preference values
 107    */
 108   double f_rel[GNUNET_ATS_PreferenceCount];
 109
 110   struct GNUNET_TIME_Absolute next_aging[GNUNET_ATS_PreferenceCount];
 111 };
 112
 113 /**
 114  * Relative preferences for a peer
 115  */
 116 struct PeerRelative
 117 {
 118   /**
 119    * Relative preference values
 120    */
 121   double f_rel[GNUNET_ATS_PreferenceCount];
 122
 123   /**
 124    * Peer id
 125    */
 126   struct GNUNET_PeerIdentity id;
 127 };
 128
 129 /**
 130  * Callback to call on changing preference values
 131  */
 132 static GAS_Normalization_preference_changed_cb pref_changed_cb;
 133
 134 /**
 135  * Closure for callback to call on changing preference values
 136  */
 137 static void *pref_changed_cb_cls;
 138
 139 /**
 140  * Callback to call on changing property values
 141  */
 142 GAS_Normalization_property_changed_cb prop_ch_cb;
 143
 144 /**
 145  * Closure for callback to call on changing property values
 146  */
 147 void *prop_ch_cb_cls;
 148
 149 /**
 150  * Hashmap to store peer information for preference normalization
 151  */
 152 static struct GNUNET_CONTAINER_MultiPeerMap *preference_peers;
 153
 154 /**
 155  * Hashmap to store peer information for property normalization
 156  * FIXME: this map is not used!
 157  */
 158 static struct GNUNET_CONTAINER_MultiPeerMap *property_peers;
 159
 160 /**
 161  * Clients in DLL: head
 162  */
 163 static struct PreferenceClient *pc_head;
 164
 165 /**
 166  * Clients in DLL: tail
 167  */
 168 static struct PreferenceClient *pc_tail;
 169
 170 /**
 171  * Default values
 172  */
 173 static struct PeerRelative defvalues;
 174
 175 static GNUNET_SCHEDULER_TaskIdentifier aging_task;
 176
 177 /**
 178  * Application Preference Normalization
 179  */
 180
 181 /**
 182  * Update a peer
 183  * @param id peer id
 184  * @param kind the kind
 185  * @return the new relative preference
 186  */
 187 static double
 188 update_peers (struct GNUNET_PeerIdentity *id,
 189     enum GNUNET_ATS_PreferenceKind kind)
 190 {
 191   struct PreferenceClient *c_cur;
 192   struct PreferencePeer *p_cur;
 193   struct PeerRelative *rp;
 194   double f_rel_total;
 195   double backup;
 196   unsigned int count;
 197
 198   f_rel_total = 0.0;
 199   count = 0;
 200
 201   /* For all clients */
 202   for (c_cur = pc_head; NULL != c_cur; c_cur = c_cur->next)
 203   {
 204     /* Find peer with id */
 205     for (p_cur = c_cur->p_head; NULL != p_cur; p_cur = p_cur->next)
 206     {
 207       if (0 == memcmp (id, &p_cur->id, sizeof(struct GNUNET_PeerIdentity)))
 208         break;
 209     }
 210     if (NULL != p_cur)
 211     {
 212       /* Found peer with id */
 213       f_rel_total += p_cur->f_rel[kind];
 214       count++;
 215     }
 216   }
 217
 218   /* Find a client */
 219   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 220       "%u clients have a total relative preference for peer `%s''s `%s' of %.3f\n",
 221       count, GNUNET_i2s (id), GNUNET_ATS_print_preference_type (kind),
 222       f_rel_total);
 223   if (NULL != (rp = GNUNET_CONTAINER_multipeermap_get (preference_peers, id)))
 224   {
 225     backup = rp->f_rel[kind];
 226     if (0 < count)
 227     {
 228       rp->f_rel[kind] = f_rel_total / count;
 229     }
 230     else
 231     {
 232       rp->f_rel[kind] = DEFAULT_REL_PREFERENCE;
 233     }
 234   }
 235   else
 236   {
 237     return DEFAULT_REL_PREFERENCE;
 238   }
 239
 240   if ((backup != rp->f_rel[kind]) && (NULL != pref_changed_cb))
 241   {
 242     pref_changed_cb (pref_changed_cb_cls, &rp->id, kind, rp->f_rel[kind]);
 243   }
 244
 245   return rp->f_rel[kind];
 246 }
 247
 248 /**
 249  * Recalculate preference for a specific ATS property
 250  *
 251  * @param c the preference client
 252  * @param p the peer
 253  * @param kind the preference kind
 254  * @return the result
 255  */
 256 static double
 257 recalculate_rel_preferences (struct PreferenceClient *c,
 258     struct PreferencePeer *p, enum GNUNET_ATS_PreferenceKind kind)
 259 {
 260   struct PreferencePeer *p_cur;
 261   struct PeerRelative *rp;
 262   double backup;
 263   double res;
 264   double ret;
 265
 266   /* For this client: sum preferences to total preference */
 267   c->f_abs_sum[kind] = 0;
 268   for (p_cur = c->p_head; NULL != p_cur; p_cur = p_cur->next)
 269     c->f_abs_sum[kind] += p_cur->f_abs[kind];
 270   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 271       "Client %p has total preference for %s of %.3f\n", c->client,
 272       GNUNET_ATS_print_preference_type (kind), c->f_abs_sum[kind]);
 273
 274   ret = DEFAULT_REL_PREFERENCE;
 275   /* For all peers: calculate relative preference */
 276   for (p_cur = c->p_head; NULL != p_cur; p_cur = p_cur->next)
 277   {
 278     /* Calculate relative preference for specific kind */
 279     backup = p_cur->f_rel[kind];
 280     if (DEFAULT_ABS_PREFERENCE == c->f_abs_sum[kind])
 281       /* No peer has a preference for this property,
 282        * so set default preference */
 283       p_cur->f_rel[kind] = DEFAULT_REL_PREFERENCE;
 284     else
 285       p_cur->f_rel[kind] = (c->f_abs_sum[kind] + p_cur->f_abs[kind])
 286           / c->f_abs_sum[kind];
 287
 288     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 289         "Client %p: peer `%s' has relative preference for %s of %.3f\n",
 290         c->client, GNUNET_i2s (&p_cur->id),
 291         GNUNET_ATS_print_preference_type (kind), p_cur->f_rel[kind]);
 292
 293     if (p_cur->f_rel[kind] != backup)
 294     {
 295       /* Value changed, recalculate */
 296       res = update_peers (&p_cur->id, kind);
 297       if (0 == memcmp (&p->id, &p_cur->id, sizeof(struct GNUNET_PeerIdentity)))
 298         ret = res;
 299     }
 300     else
 301     {
 302       /* Value did not chang, return old value*/
 303       GNUNET_assert(
 304           NULL != (rp = GNUNET_CONTAINER_multipeermap_get (preference_peers, &p->id)));
 305       ret = rp->f_rel[kind];
 306     }
 307   }
 308   return ret;
 309 }
 310
 311 /**
 312  * Update the absolute preference value for a peer
 313  * @param c the client
 314  * @param p the peer
 315  * @param kind the preference kind
 316  * @param score_abs the absolute value
 317  * @return the new relative preference value
 318  */
 319 static double
 320 update_preference (struct PreferenceClient *c, struct PreferencePeer *p,
 321     enum GNUNET_ATS_PreferenceKind kind, float score_abs)
 322 {
 323   double score = score_abs;
 324
 325   /* Update preference value according to type */
 326   switch (kind)
 327   {
 328   case GNUNET_ATS_PREFERENCE_BANDWIDTH:
 329   case GNUNET_ATS_PREFERENCE_LATENCY:
 330     p->f_abs[kind] = (p->f_abs[kind] + score) / 2;
 331     p->next_aging[kind] = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get (),
 332         PREF_AGING_INTERVAL);
 333     break;
 334   case GNUNET_ATS_PREFERENCE_END:
 335     break;
 336   default:
 337     break;
 338   }
 339   return recalculate_rel_preferences (c, p, kind);
 340 }
 341
 342 /**
 343  * Reduce absolute preferences since they got old
 344  *
 345  * @param cls the PreferencePeer
 346  * @param tc context
 347  */
 348 static void
 349 preference_aging (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 350 {
 351   struct PreferencePeer *p;
 352   struct PreferenceClient *cur_client;
 353   int i;
 354   int values_to_update;
 355   double backup;
 356
 357   aging_task = GNUNET_SCHEDULER_NO_TASK;
 358   values_to_update = 0;
 359   cur_client = NULL;
 360
 361   for (cur_client = pc_head; NULL != cur_client; cur_client = cur_client->next)
 362   {
 363     for (p = cur_client->p_head; NULL != p; p = p->next)
 364     {
 365       /* Aging absolute values: */
 366       for (i = 0; i < GNUNET_ATS_PreferenceCount; i++)
 367       {
 368         if (0
 369             == GNUNET_TIME_absolute_get_remaining (p->next_aging[i]).rel_value_us)
 370         {
 371           GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 372               "Aging preference for peer `%s'\n", GNUNET_i2s (&p->id));
 373           backup = p->f_abs[i];
 374           if (p->f_abs[i] > DEFAULT_ABS_PREFERENCE)
 375             p->f_abs[i] *= PREF_AGING_FACTOR;
 376           if (p->f_abs[i] <= DEFAULT_ABS_PREFERENCE + PREF_EPSILON)
 377             p->f_abs[i] = DEFAULT_ABS_PREFERENCE;
 378           if ((p->f_abs[i] != DEFAULT_ABS_PREFERENCE)
 379               && (backup != p->f_abs[i]))
 380           {
 381             GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 382                 "Aged preference for peer `%s' from %.3f to %.3f\n",
 383                 GNUNET_i2s (&p->id), backup, p->f_abs[i]);
 384             recalculate_rel_preferences (p->client, p, i);
 385             p->next_aging[i] = GNUNET_TIME_absolute_add (
 386                 GNUNET_TIME_absolute_get (), PREF_AGING_INTERVAL);
 387             values_to_update++;
 388           }
 389         }
 390       }
 391     }
 392   }
 393
 394   if (values_to_update > 0)
 395   {
 396     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 397         "Rescheduling aging task due to %u elements to age\n",
 398         values_to_update);
 399     aging_task = GNUNET_SCHEDULER_add_delayed (PREF_AGING_INTERVAL,
 400         &preference_aging, NULL );
 401   }
 402   else
 403     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 404         "No values to age left, not rescheduling aging task\n");
 405
 406 }
 407
 408 /**
 409  * Normalize an updated preference value
 410  *
 411  * @param src the client with this preference
 412  * @param peer the peer to change the preference for
 413  * @param kind the kind to change the preference
 414  * @param score_abs the normalized score
 415  */
 416 void
 417 GAS_normalization_normalize_preference (void *src,
 418     const struct GNUNET_PeerIdentity *peer, enum GNUNET_ATS_PreferenceKind kind,
 419     float score_abs)
 420 {
 421   struct PreferenceClient *c_cur;
 422   struct PreferencePeer *p_cur;
 423   struct PeerRelative *r_cur;
 424   int i;
 425
 426   GNUNET_assert(NULL != src);
 427   GNUNET_assert(NULL != peer);
 428
 429   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 430       "Client %p changes preference for peer `%s' for `%s' to %.2f\n", src,
 431       GNUNET_i2s (peer), GNUNET_ATS_print_preference_type (kind), score_abs);
 432
 433   if (kind >= GNUNET_ATS_PreferenceCount)
 434   {
 435     GNUNET_break(0);
 436     return;
 437   }
 438
 439   /* Find preference client */
 440   for (c_cur = pc_head; NULL != c_cur; c_cur = c_cur->next)
 441   {
 442     if (src == c_cur->client)
 443       break;
 444   }
 445   /* Not found: create new preference client */
 446   if (NULL == c_cur)
 447   {
 448     c_cur = GNUNET_malloc (sizeof (struct PreferenceClient));
 449     c_cur->client = src;
 450     GNUNET_CONTAINER_DLL_insert(pc_head, pc_tail, c_cur);
 451     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Adding new client %p \n", c_cur);
 452   }
 453
 454   /* Find entry for peer */
 455   for (p_cur = c_cur->p_head; NULL != p_cur; p_cur = p_cur->next)
 456     if (0 == memcmp (&p_cur->id, peer, sizeof(p_cur->id)))
 457       break;
 458
 459   /* Not found: create new peer entry */
 460   if (NULL == p_cur)
 461   {
 462     p_cur = GNUNET_malloc (sizeof (struct PreferencePeer));
 463     p_cur->client = c_cur;
 464     p_cur->id = (*peer);
 465     for (i = 0; i < GNUNET_ATS_PreferenceCount; i++)
 466     {
 467       /* Default value per peer absolut preference for a quality:
 468        * No value set, so absolute preference 0 */
 469       p_cur->f_abs[i] = DEFAULT_ABS_PREFERENCE;
 470       /* Default value per peer relative preference for a quality: 1.0 */
 471       p_cur->f_rel[i] = DEFAULT_REL_PREFERENCE;
 472       p_cur->next_aging[i] = GNUNET_TIME_UNIT_FOREVER_ABS;
 473     }
 474     GNUNET_CONTAINER_DLL_insert(c_cur->p_head, c_cur->p_tail, p_cur);
 475   }
 476
 477   if (NULL == GNUNET_CONTAINER_multipeermap_get (preference_peers, peer))
 478   {
 479     r_cur = GNUNET_malloc (sizeof (struct PeerRelative));
 480     r_cur->id = (*peer);
 481     for (i = 0; i < GNUNET_ATS_PreferenceCount; i++)
 482       r_cur->f_rel[i] = DEFAULT_REL_PREFERENCE;
 483     GNUNET_CONTAINER_multipeermap_put (preference_peers, &r_cur->id, r_cur,
 484         GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
 485   }
 486
 487   if (GNUNET_SCHEDULER_NO_TASK == aging_task)
 488     aging_task = GNUNET_SCHEDULER_add_delayed (PREF_AGING_INTERVAL,
 489         &preference_aging, NULL );
 490
 491   update_preference (c_cur, p_cur, kind, score_abs);
 492 }
 493
 494 /**
 495  * Get the normalized preference values for a specific peer or
 496  * the default values if
 497  *
 498  * @param id the peer
 499  * @return pointer to the values, can be indexed with GNUNET_ATS_PreferenceKind,
 500  * default preferences if peer does not exist
 501  */
 502 const double *
 503 GAS_normalization_get_preferences_by_peer (const struct GNUNET_PeerIdentity *id)
 504 {
 505   GNUNET_assert(NULL != preference_peers);
 506   GNUNET_assert(NULL != id);
 507
 508   struct PeerRelative *rp;
 509   if (NULL == (rp = GNUNET_CONTAINER_multipeermap_get (preference_peers, id)))
 510   {
 511     return defvalues.f_rel;
 512   }
 513   return rp->f_rel;
 514 }
 515
 516 /**
 517  * Get the normalized preference values for a specific client and peer
 518  *
 519  * @param id the peer
 520  * @param the peer
 521  * @return the value
 522  */
 523 const double
 524 GAS_normalization_get_preferences_by_client (const void *client,
 525     struct GNUNET_PeerIdentity *peer, enum GNUNET_ATS_PreferenceKind pref)
 526 {
 527   struct PreferenceClient *c_cur;
 528   struct PreferencePeer *p_cur;
 529
 530   /* Find preference client */
 531   for (c_cur = pc_head; NULL != c_cur; c_cur = c_cur->next)
 532   {
 533     if (client == c_cur->client)
 534       break;
 535   }
 536   if (NULL == c_cur)
 537     return -1.0;
 538
 539   for (p_cur = c_cur->p_head; NULL != p_cur; p_cur = p_cur->next)
 540   {
 541     if (0 == memcmp (peer, &p_cur->id, sizeof (struct GNUNET_PeerIdentity)))
 542       break;
 543   }
 544   if (NULL == p_cur)
 545     return DEFAULT_REL_PREFERENCE; /* Not found, return default */
 546
 547   return p_cur->f_rel[pref];
 548 }
 549
 550 /**
 551  * Get the normalized properties values for a specific peer or
 552  * the default values if
 553  *
 554  * @param address the address
 555  * @return pointer to the values, can be indexed with GNUNET_ATS_PreferenceKind,
 556  * default preferences if peer does not exist
 557  */
 558 const double *
 559 GAS_normalization_get_properties (struct ATS_Address *address)
 560 {
 561   static double norm_values[GNUNET_ATS_QualityPropertiesCount];
 562   int i;
 563
 564   GNUNET_assert(NULL != address);
 565
 566   for (i = 0; i < GNUNET_ATS_QualityPropertiesCount; i++)
 567   {
 568     if ((address->atsin[i].norm >= 1.0) && (address->atsin[i].norm <= 2.0))
 569       norm_values[i] = address->atsin[i].norm;
 570     else
 571       norm_values[i] = DEFAULT_REL_QUALITY;
 572   }
 573   return norm_values;
 574 }
 575
 576 /**
 577  * Quality Normalization
 578  */
 579
 580 struct Property
 581 {
 582   uint32_t prop_type;
 583   uint32_t atsi_type;
 584   uint32_t min;
 585   uint32_t max;
 586 };
 587
 588 struct Property properties[GNUNET_ATS_QualityPropertiesCount];
 589
 590 /**
 591  * Normalize a specific ATS type with the values in queue
 592  * @param address the address
 593  * @param atsi the ats information
 594  * @return the new average or GNUNET_ATS_VALUE_UNDEFINED
 595  */
 596
 597 uint32_t
 598 property_average (struct ATS_Address *address,
 599     const struct GNUNET_ATS_Information *atsi)
 600 {
 601   struct GAS_NormalizationInfo *ni;
 602   uint32_t current_type;
 603   uint32_t current_val;
 604   uint32_t res;
 605   uint64_t sum;
 606   uint32_t count;
 607   unsigned int c1;
 608   unsigned int index;
 609   unsigned int props[] = GNUNET_ATS_QualityProperties;
 610
 611   /* Average the values of this property */
 612   current_type = ntohl (atsi->type);
 613   current_val = ntohl (atsi->value);
 614
 615   for (c1 = 0; c1 < GNUNET_ATS_QualityPropertiesCount; c1++)
 616   {
 617     if (current_type == props[c1])
 618       break;
 619   }
 620   if (c1 == GNUNET_ATS_QualityPropertiesCount)
 621   {
 622     GNUNET_break(0);
 623     return GNUNET_ATS_VALUE_UNDEFINED;
 624   }
 625   index = c1;
 626
 627   ni = &address->atsin[index];
 628   ni->atsi_abs[ni->avg_queue_index] = current_val;
 629   ni->avg_queue_index++;
 630   if (GAS_normalization_queue_length == ni->avg_queue_index)
 631     ni->avg_queue_index = 0;
 632
 633   count = 0;
 634   sum = 0;
 635   for (c1 = 0; c1 < GAS_normalization_queue_length; c1++)
 636   {
 637     if (GNUNET_ATS_VALUE_UNDEFINED != ni->atsi_abs[c1])
 638     {
 639       count++;
 640       if (GNUNET_ATS_VALUE_UNDEFINED > (sum + ni->atsi_abs[c1]))
 641         sum += ni->atsi_abs[c1];
 642       else
 643       {
 644         sum = GNUNET_ATS_VALUE_UNDEFINED - 1;
 645         GNUNET_break(0);
 646       }
 647     }
 648   }
 649   GNUNET_assert(0 != count);
 650   res = sum / count;
 651   LOG(GNUNET_ERROR_TYPE_DEBUG,
 652       "New average of `%s' created by adding %u from %u elements: %u\n",
 653       GNUNET_ATS_print_property_type (current_type), current_val, count, res,
 654       sum);
 655   ni->avg = res;
 656   return res;
 657 }
 658
 659 struct FindMinMaxCtx
 660 {
 661   struct Property *p;
 662   uint32_t min;
 663   uint32_t max;
 664 };
 665
 666 static int
 667 find_min_max_it (void *cls, const struct GNUNET_PeerIdentity *h, void *k)
 668 {
 669   struct FindMinMaxCtx *find_res = cls;
 670   struct ATS_Address *a = k;
 671
 672   if (a->atsin[find_res->p->prop_type].avg > find_res->max)
 673     find_res->max = a->atsin[find_res->p->prop_type].avg;
 674
 675   if (a->atsin[find_res->p->prop_type].avg < find_res->min)
 676     find_res->min = a->atsin[find_res->p->prop_type].avg;
 677
 678   return GNUNET_OK;
 679 }
 680
 681 static int
 682 normalize_address (void *cls, const struct GNUNET_PeerIdentity *h, void *k)
 683 {
 684   struct Property *p = cls;
 685   struct ATS_Address *address = k;
 686
 687   double delta;
 688   uint32_t avg_value = address->atsin[p->prop_type].avg;
 689
 690   delta = p->max - p->min;
 691   address->atsin[p->prop_type].norm = (delta + (avg_value - p->min)) / (delta);
 692
 693   LOG(GNUNET_ERROR_TYPE_DEBUG,
 694       "Normalize `%s' address %p's '%s' with value %u to range [%u..%u] = %.3f\n",
 695       GNUNET_i2s (&address->peer), address,
 696       GNUNET_ATS_print_property_type (p->atsi_type),
 697       address->atsin[p->prop_type].avg, p->min, p->max,
 698       address->atsin[p->prop_type].norm);
 699
 700   if (NULL != prop_ch_cb)
 701     prop_ch_cb (prop_ch_cb_cls, address, p->atsi_type,
 702         address->atsin[p->prop_type].norm);
 703
 704   return GNUNET_OK;
 705 }
 706
 707 /**
 708  * Normalize avg_value to a range of values between [1.0, 2.0]
 709  * based on min max values currently known.
 710  *
 711  * @param addresses the address hashmap
 712  * @param p the property
 713  * @param address the address
 714  * @param avg_value the value to normalize
 715  */
 716 static void
 717 property_normalize (struct GNUNET_CONTAINER_MultiPeerMap *addresses,
 718     struct Property *p, struct ATS_Address *address, uint32_t avg_value)
 719 {
 720   struct FindMinMaxCtx find_ctx;
 721   int addr_count;
 722   int limits_changed;
 723
 724   find_ctx.p = p;
 725   find_ctx.max = 0;
 726   find_ctx.min = UINT32_MAX;
 727   addr_count = GNUNET_CONTAINER_multipeermap_iterate (addresses,
 728       &find_min_max_it, &find_ctx);
 729   if (0 == addr_count)
 730   {
 731     GNUNET_break(0);
 732     return;
 733   }
 734
 735   limits_changed = GNUNET_NO;
 736   if (find_ctx.max != p->max)
 737   {
 738     LOG(GNUNET_ERROR_TYPE_DEBUG,
 739         "Normalizing %s: new maximum %u -> recalculate all values\n",
 740         GNUNET_ATS_print_property_type (p->atsi_type), find_ctx.max);
 741     p->max = find_ctx.max;
 742     limits_changed = GNUNET_YES;
 743   }
 744
 745   if ((find_ctx.min != p->min) && (find_ctx.min < p->max))
 746   {
 747     LOG(GNUNET_ERROR_TYPE_DEBUG,
 748         "Normalizing %s: new minimum %u -> recalculate all values\n",
 749         GNUNET_ATS_print_property_type (p->atsi_type), find_ctx.min,
 750         find_ctx.max);
 751     p->min = find_ctx.min;
 752     limits_changed = GNUNET_YES;
 753   }
 754   else if (find_ctx.min == p->max)
 755   {
 756     /* Only one value, so minimum has to be 0 */
 757     p->min = 0;
 758   }
 759
 760   /* Normalize the values of this property */
 761   if (GNUNET_NO == limits_changed)
 762   {
 763     /* normalize just this  address */
 764     normalize_address (p, &address->peer, address);
 765     return;
 766   }
 767   else
 768   {
 769     /* limits changed, normalize all addresses */
 770     GNUNET_CONTAINER_multipeermap_iterate (addresses, &normalize_address, p);
 771     return;
 772   }
 773 }
 774
 775 /**
 776  * Update and normalize atsi performance information
 777  *
 778  * @param addresses hashmap containing all addresses
 779  * @param address the address to update
 780  * @param atsi the array of performance information
 781  * @param atsi_count the number of atsi information in the array
 782  */
 783 void
 784 GAS_normalization_normalize_property (
 785     struct GNUNET_CONTAINER_MultiPeerMap *addresses,
 786     struct ATS_Address *address, const struct GNUNET_ATS_Information *atsi,
 787     uint32_t atsi_count)
 788 {
 789   struct Property *cur_prop;
 790   int c1;
 791   int c2;
 792   uint32_t current_type;
 793   uint32_t current_val;
 794   unsigned int existing_properties[] = GNUNET_ATS_QualityProperties;
 795
 796   GNUNET_assert(NULL != address);
 797   GNUNET_assert(NULL != atsi);
 798
 799   LOG(GNUNET_ERROR_TYPE_DEBUG, "Updating %u elements for peer `%s'\n",
 800       atsi_count, GNUNET_i2s (&address->peer));
 801
 802   for (c1 = 0; c1 < atsi_count; c1++)
 803   {
 804     current_type = ntohl (atsi[c1].type);
 805
 806     for (c2 = 0; c2 < GNUNET_ATS_QualityPropertiesCount; c2++)
 807     {
 808       /* Check if type is valid */
 809       if (current_type == existing_properties[c2])
 810         break;
 811     }
 812     if (GNUNET_ATS_QualityPropertiesCount == c2)
 813     {
 814       /* Invalid property, continue with next element */
 815       continue;
 816     }
 817     /* Averaging */
 818     current_val = property_average (address, &atsi[c1]);
 819     if (GNUNET_ATS_VALUE_UNDEFINED == current_val)
 820     {
 821       GNUNET_break(0);
 822       continue;
 823     }
 824
 825     /* Normalizing */
 826     /* Check min, max */
 827     cur_prop = &properties[c2];
 828     property_normalize (addresses, cur_prop, address, current_val);
 829   }
 830 }
 831
 832 static void
 833 free_client (struct PreferenceClient *pc)
 834 {
 835   struct PreferencePeer *next_p;
 836   struct PreferencePeer *p;
 837   next_p = pc->p_head;
 838   while (NULL != (p = next_p))
 839   {
 840     next_p = p->next;
 841     GNUNET_CONTAINER_DLL_remove(pc->p_head, pc->p_tail, p);
 842     GNUNET_free(p);
 843   }
 844   GNUNET_free(pc);
 845 }
 846
 847 /**
 848  * A performance client disconnected
 849  *
 850  * @param client the client
 851  */
 852
 853 void
 854 GAS_normalization_preference_client_disconnect (void *client)
 855 {
 856   struct PreferenceClient *c_cur;
 857   /* Find preference client */
 858
 859   for (c_cur = pc_head; NULL != c_cur; c_cur = c_cur->next)
 860   {
 861     if (client == c_cur->client)
 862       break;
 863   }
 864   if (NULL == c_cur)
 865     return;
 866
 867   GNUNET_CONTAINER_DLL_remove(pc_head, pc_tail, c_cur);
 868   free_client (c_cur);
 869 }
 870
 871 /**
 872  * Start the normalization component
 873  *
 874  * @param pref_ch_cb callback to call on relative preference changing
 875  * @param pref_ch_cb_cls cls for the preference callback
 876  * @param property_ch_cb callback to call on relative property changing
 877  * @param property_ch_cb_cls cls for the property callback
 878  */
 879 void
 880 GAS_normalization_start (GAS_Normalization_preference_changed_cb pref_ch_cb,
 881     void *pref_ch_cb_cls, GAS_Normalization_property_changed_cb property_ch_cb,
 882     void *property_ch_cb_cls)
 883 {
 884   int c1;
 885   int i;
 886   preference_peers = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
 887   property_peers = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
 888   unsigned int existing_properties[] = GNUNET_ATS_QualityProperties;
 889
 890   for (c1 = 0; c1 < GNUNET_ATS_QualityPropertiesCount; c1++)
 891   {
 892     properties[c1].prop_type = c1;
 893     properties[c1].atsi_type = existing_properties[c1];
 894     properties[c1].min = 0;
 895     properties[c1].max = 0;
 896   }
 897
 898   pref_changed_cb = pref_ch_cb;
 899   pref_changed_cb_cls = pref_ch_cb_cls;
 900   prop_ch_cb = property_ch_cb;
 901   prop_ch_cb_cls = pref_ch_cb_cls;
 902
 903   pc_head = NULL;
 904   pc_tail = NULL;
 905
 906   for (i = 0; i < GNUNET_ATS_PreferenceCount; i++)
 907     defvalues.f_rel[i] = DEFAULT_REL_PREFERENCE;
 908   aging_task = GNUNET_SCHEDULER_NO_TASK;
 909   return;
 910 }
 911
 912 /**
 913  * Free a peer
 914  *
 915  * @param cls unused
 916  * @param key the key
 917  * @param value RelativePeer
 918  * @return #GNUNET_OK to continue
 919  */
 920 static int
 921 free_peer (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
 922 {
 923   struct PeerRelative *rp = value;
 924   if (GNUNET_YES
 925       == GNUNET_CONTAINER_multipeermap_remove (preference_peers, key, value))
 926     GNUNET_free(rp);
 927   else
 928     GNUNET_break(0);
 929   return GNUNET_OK;
 930 }
 931
 932 /**
 933  * Stop the normalization component and free all items
 934  */
 935 void
 936 GAS_normalization_stop ()
 937 {
 938   struct PreferenceClient *pc;
 939   struct PreferenceClient *next_pc;
 940
 941   if (GNUNET_SCHEDULER_NO_TASK != aging_task)
 942   {
 943     GNUNET_SCHEDULER_cancel (aging_task);
 944     aging_task = GNUNET_SCHEDULER_NO_TASK;
 945   }
 946
 947   next_pc = pc_head;
 948   while (NULL != (pc = next_pc))
 949   {
 950     next_pc = pc->next;
 951     GNUNET_CONTAINER_DLL_remove(pc_head, pc_tail, pc);
 952     free_client (pc);
 953   }
 954
 955   GNUNET_CONTAINER_multipeermap_iterate (preference_peers, &free_peer, NULL );
 956   GNUNET_CONTAINER_multipeermap_destroy (preference_peers);
 957   GNUNET_CONTAINER_multipeermap_destroy (property_peers);
 958   return;
 959 }
 960
 961 /* end of gnunet-service-ats_normalization.c */