src/ats/gnunet-service-ats_addresses_simplistic.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_addresses_simplistic.h
  23  * @brief ats simplistic ressource assignment
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #include "platform.h"
  28 #include "gnunet_util_lib.h"
  29 #include "gnunet-service-ats_addresses.h"
  30 #include "gnunet_statistics_service.h"
  31
  32 #define LOG(kind,...) GNUNET_log_from (kind, "ats-simplistic",__VA_ARGS__)
  33
  34 /**
  35  * ATS simplistic solver
  36  *
  37  * Assigns in and outbound bandwidth equally for all addresses in specific
  38  * network type (WAN, LAN) based on configured in and outbound quota for this
  39  * network.
  40  *
  41  * For each peer only a single is selected and marked as "active" in the address
  42  * struct.
  43  *
  44  * E.g.:
  45  *
  46  * You have the networks WAN and LAN and quotas
  47  * WAN_TOTAL_IN, WAN_TOTAL_OUT
  48  * LAN_TOTAL_IN, LAN_TOTAL_OUT
  49  *
  50  * If you have x addresses in the network segment LAN, the quotas are
  51  * QUOTA_PER_ADDRESS = LAN_TOTAL_OUT / x
  52  *
  53  * Quotas are automatically recalculated and reported back when addresses are
  54  * - requested
  55  *
  56  */
  57
  58 #define DEFAULT_PREFERENCE 1.0
  59 #define MIN_UPDATE_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
  60
  61 /**
  62  * A handle for the simplistic solver
  63  */
  64 struct GAS_SIMPLISTIC_Handle
  65 {
  66   /**
  67    * Statistics handle
  68    */
  69
  70   struct GNUNET_STATISTICS_Handle *stats;
  71
  72   /**
  73    * Total number of addresses for solver
  74    */
  75   unsigned int total_addresses;
  76
  77   /**
  78    * Number of active addresses for solver
  79    */
  80   unsigned int active_addresses;
  81
  82   /**
  83    * Networks array
  84    */
  85   struct Network *network_entries;
  86
  87   /**
  88    * Number of networks
  89    */
  90   unsigned int networks;
  91
  92   /**
  93    * Callback
  94    */
  95   GAS_bandwidth_changed_cb bw_changed;
  96
  97   /**
  98    * Callback cls
  99    */
 100   void *bw_changed_cls;
 101
 102   struct GNUNET_CONTAINER_MultiHashMap *prefs;
 103
 104   struct PreferenceClient *pc_head;
 105   struct PreferenceClient *pc_tail;
 106 };
 107
 108 struct Network
 109 {
 110   /**
 111    * ATS network type
 112    */
 113   unsigned int type;
 114
 115   /**
 116    * Network description
 117    */
 118   char *desc;
 119
 120   /**
 121    * Total inbound quota
 122    *
 123    */
 124   unsigned long long total_quota_in;
 125
 126   /**
 127    * Total outbound quota
 128    *
 129    */
 130   unsigned long long total_quota_out;
 131
 132   /**
 133    * Number of active addresses for this network
 134    */
 135   unsigned int active_addresses;
 136
 137   /**
 138    * Number of total addresses for this network
 139    */
 140   unsigned int total_addresses;
 141
 142   /**
 143    * String for statistics total addresses
 144    */
 145   char *stat_total;
 146
 147   /**
 148    * String for statistics active addresses
 149    */
 150   char *stat_active;
 151
 152   struct AddressWrapper *head;
 153   struct AddressWrapper *tail;
 154 };
 155
 156 struct AddressWrapper
 157 {
 158   struct AddressWrapper *next;
 159   struct AddressWrapper *prev;
 160
 161   struct ATS_Address *addr;
 162 };
 163
 164
 165 struct PreferencePeer
 166 {
 167   struct PreferencePeer *next;
 168   struct PreferencePeer *prev;
 169   struct GNUNET_PeerIdentity id;
 170
 171   float f[GNUNET_ATS_PreferenceCount];
 172   float f_rel[GNUNET_ATS_PreferenceCount];
 173   float f_rel_total;
 174 };
 175
 176 struct PreferenceClient
 177 {
 178   struct PreferenceClient *prev;
 179   struct PreferenceClient *next;
 180   void *client;
 181
 182   float f_total[GNUNET_ATS_PreferenceCount];
 183
 184   struct PreferencePeer *p_head;
 185   struct PreferencePeer *p_tail;
 186 };
 187
 188
 189 /**
 190  * Get the prefered address for a specific peer
 191  *
 192  * @param solver the solver handle
 193  * @param addresses the address hashmap containing all addresses
 194  * @param peer the identity of the peer
 195  */
 196 const struct ATS_Address *
 197 GAS_simplistic_get_preferred_address (void *solver,
 198                                struct GNUNET_CONTAINER_MultiHashMap * addresses,
 199                                const struct GNUNET_PeerIdentity *peer);
 200
 201 /**
 202  * Init the simplistic problem solving component
 203  *
 204  * Quotas:
 205  * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
 206  * out_quota[i] contains outbound quota for network type i
 207  * in_quota[i] contains inbound quota for network type i
 208  *
 209  * Example
 210  * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
 211  * network[2]   == GNUNET_ATS_NET_LAN
 212  * out_quota[2] == 65353
 213  * in_quota[2]  == 65353
 214  *
 215  * @param cfg configuration handle
 216  * @param stats the GNUNET_STATISTICS handle
 217  * @param network array of GNUNET_ATS_NetworkType with length dest_length
 218  * @param out_quota array of outbound quotas
 219  * @param in_quota array of outbound quota
 220  * @param dest_length array length for quota arrays
 221  * @param bw_changed_cb callback for changed bandwidth amounts
 222  * @param bw_changed_cb_cls cls for callback
 223  * @return handle for the solver on success, NULL on fail
 224  */
 225 void *
 226 GAS_simplistic_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 227                      const struct GNUNET_STATISTICS_Handle *stats,
 228                      int *network,
 229                      unsigned long long *out_quota,
 230                      unsigned long long *in_quota,
 231                      int dest_length,
 232                      GAS_bandwidth_changed_cb bw_changed_cb,
 233                      void *bw_changed_cb_cls)
 234 {
 235   int c;
 236   struct GAS_SIMPLISTIC_Handle *s = GNUNET_malloc (sizeof (struct GAS_SIMPLISTIC_Handle));
 237   struct Network * cur;
 238   char * net_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
 239
 240
 241   s->stats = (struct GNUNET_STATISTICS_Handle *) stats;
 242   s->bw_changed = bw_changed_cb;
 243   s->bw_changed_cls = bw_changed_cb_cls;
 244   s->networks = dest_length;
 245   s->network_entries = GNUNET_malloc (dest_length * sizeof (struct Network));
 246   s->active_addresses = 0;
 247   s->total_addresses = 0;
 248   s->prefs = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
 249
 250   for (c = 0; c < dest_length; c++)
 251   {
 252       cur = &s->network_entries[c];
 253       cur->total_addresses = 0;
 254       cur->active_addresses = 0;
 255       cur->type = network[c];
 256       cur->total_quota_in = in_quota[c];
 257       cur->total_quota_out = out_quota[c];
 258       cur->desc = net_str[c];
 259       GNUNET_asprintf (&cur->stat_total, "# ATS addresses %s total", cur->desc);
 260       GNUNET_asprintf (&cur->stat_active, "# ATS active addresses %s total", cur->desc);
 261   }
 262   return s;
 263 }
 264
 265 static int
 266 free_pref (void *cls,
 267            const struct GNUNET_HashCode * key,
 268            void *value)
 269 {
 270   float *v = value;
 271   GNUNET_free (v);
 272   return GNUNET_OK;
 273 }
 274
 275 /**
 276  * Shutdown the simplistic problem solving component
 277  *
 278  * @param solver the respective handle to shutdown
 279  */
 280 void
 281 GAS_simplistic_done (void *solver)
 282 {
 283   struct GAS_SIMPLISTIC_Handle *s = solver;
 284   struct PreferenceClient *pc;
 285   struct PreferenceClient *next_pc;
 286   struct PreferencePeer *p;
 287   struct PreferencePeer *next_p;
 288   struct AddressWrapper *cur;
 289   struct AddressWrapper *next;
 290   int c;
 291   GNUNET_assert (s != NULL);
 292
 293   for (c = 0; c < s->networks; c++)
 294   {
 295       if (s->network_entries[c].total_addresses > 0)
 296       {
 297         LOG (GNUNET_ERROR_TYPE_ERROR,
 298                     "Had %u addresses for network `%s' not deleted during shutdown\n",
 299                     s->network_entries[c].total_addresses,
 300                     s->network_entries[c].desc);
 301         GNUNET_break (0);
 302       }
 303
 304       if (s->network_entries[c].active_addresses > 0)
 305       {
 306         LOG (GNUNET_ERROR_TYPE_ERROR,
 307                     "Had %u active addresses for network `%s' not deleted during shutdown\n",
 308                     s->network_entries[c].active_addresses,
 309                     s->network_entries[c].desc);
 310         GNUNET_break (0);
 311       }
 312
 313       next = s->network_entries[c].head;
 314       while (NULL != (cur = next))
 315       {
 316           next = cur->next;
 317           GNUNET_CONTAINER_DLL_remove (s->network_entries[c].head,
 318                                        s->network_entries[c].tail,
 319                                        cur);
 320           GNUNET_free (cur);
 321       }
 322       GNUNET_free (s->network_entries[c].stat_total);
 323       GNUNET_free (s->network_entries[c].stat_active);
 324   }
 325   if (s->total_addresses > 0)
 326   {
 327     LOG (GNUNET_ERROR_TYPE_ERROR,
 328                 "Had %u addresses not deleted during shutdown\n",
 329                 s->total_addresses);
 330     GNUNET_break (0);
 331   }
 332   if (s->active_addresses > 0)
 333   {
 334     LOG (GNUNET_ERROR_TYPE_ERROR,
 335                 "Had %u active addresses not deleted during shutdown\n",
 336                 s->active_addresses);
 337     GNUNET_break (0);
 338   }
 339   GNUNET_free (s->network_entries);
 340
 341   next_pc = s->pc_head;
 342   while (NULL != (pc = next_pc))
 343   {
 344       next_pc = pc->next;
 345       GNUNET_CONTAINER_DLL_remove (s->pc_head, s->pc_tail, pc);
 346       next_p = pc->p_head;
 347       while (NULL != (p = next_p))
 348       {
 349           next_p = p->next;
 350           GNUNET_CONTAINER_DLL_remove (pc->p_head, pc->p_tail, p);
 351           GNUNET_free (p);
 352       }
 353       GNUNET_free (pc);
 354   }
 355
 356   GNUNET_CONTAINER_multihashmap_iterate (s->prefs, &free_pref, NULL);
 357   GNUNET_CONTAINER_multihashmap_destroy (s->prefs);
 358   GNUNET_free (s);
 359 }
 360
 361
 362 /**
 363  * Test if bandwidth is available in this network
 364  *
 365  * @param s the solver handle
 366  * @param net the network type to update
 367  * @return GNUNET_YES or GNUNET_NO
 368  */
 369
 370 static int
 371 bw_available_in_network (struct Network *net)
 372 {
 373   unsigned int na = net->active_addresses + 1;
 374   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
 375   if (((net->total_quota_in / na) > min_bw) &&
 376       ((net->total_quota_out / na) > min_bw))
 377   {
 378     LOG (GNUNET_ERROR_TYPE_DEBUG,
 379          "Enough bandwidth available for %u active addresses in network `%s'\n",
 380          na,
 381          net->desc);
 382
 383     return GNUNET_YES;
 384   }
 385     LOG (GNUNET_ERROR_TYPE_DEBUG,
 386          "Not enough bandwidth available for %u active addresses in network `%s'\n",
 387          na,
 388          net->desc);
 389   return GNUNET_NO;
 390 }
 391
 392 /**
 393  * Update the quotas for a network type
 394  *
 395  * @param s the solver handle
 396  * @param net the network type to update
 397  * @param address_except address excluded from notifcation, since we suggest
 398  * this address
 399  */
 400 static void
 401 update_quota_per_network (struct GAS_SIMPLISTIC_Handle *s,
 402                           struct Network *net,
 403                           struct ATS_Address *address_except)
 404 {
 405   unsigned long long remaining_quota_in = 0;
 406   unsigned long long quota_out_used = 0;
 407
 408   unsigned long long remaining_quota_out = 0;
 409   unsigned long long quota_in_used = 0;
 410   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
 411   float total_prefs;
 412   float cur_pref;
 413   float *t = NULL;
 414
 415   unsigned long long quota_in = 0;
 416   unsigned long long quota_out = 0;
 417   struct AddressWrapper *cur;
 418
 419   LOG (GNUNET_ERROR_TYPE_DEBUG,
 420               "Recalculate quota for network type `%s' for %u addresses (in/out): %llu/%llu \n",
 421               net->desc, net->active_addresses, quota_in, quota_out);
 422
 423   if (net->active_addresses == 0)
 424     return; /* no addresses to update */
 425
 426   /* Idea TODO
 427    *
 428    * Assign every peer in network minimum Bandwidth
 429    * Distribute bandwidth left according to preference
 430    */
 431
 432   if ((net->active_addresses * min_bw) > net->total_quota_in)
 433   {
 434     GNUNET_break (0);
 435     return;
 436   }
 437   if ((net->active_addresses * min_bw) > net->total_quota_out)
 438   {
 439     GNUNET_break (0);
 440     return;
 441   }
 442
 443   remaining_quota_in = net->total_quota_in - (net->active_addresses * min_bw);
 444   remaining_quota_out = net->total_quota_out - (net->active_addresses * min_bw);
 445   LOG (GNUNET_ERROR_TYPE_DEBUG, "Remaining bandwidth : (in/out): %llu/%llu \n",
 446               remaining_quota_in, remaining_quota_out);
 447   total_prefs = 0.0;
 448   for (cur = net->head; NULL != cur; cur = cur->next)
 449   {
 450      t = GNUNET_CONTAINER_multihashmap_get (s->prefs, &cur->addr->peer.hashPubKey);
 451      if (NULL == t)
 452        total_prefs += DEFAULT_PREFERENCE;
 453      else
 454        total_prefs += (*t);
 455   }
 456   for (cur = net->head; NULL != cur; cur = cur->next)
 457   {
 458      cur_pref = 0.0;
 459      t = GNUNET_CONTAINER_multihashmap_get (s->prefs, &cur->addr->peer.hashPubKey);
 460      if (NULL == t)
 461        cur_pref = DEFAULT_PREFERENCE;
 462      else
 463        cur_pref = (*t);
 464      quota_in = min_bw + (cur_pref / total_prefs) * (float) remaining_quota_in;
 465      quota_out = min_bw + (cur_pref / total_prefs) * (float) remaining_quota_out;
 466      LOG (GNUNET_ERROR_TYPE_DEBUG,
 467                  "New quota for peer `%s' with preference (cur/total) %.3f/%.3f (in/out): %llu /%llu\n",
 468                  GNUNET_i2s (&cur->addr->peer),
 469                  cur_pref,
 470                  total_prefs,
 471                  quota_in,
 472                  quota_out);
 473      quota_in_used += quota_in;
 474      quota_out_used += quota_out;
 475      /* Prevent overflow due to rounding errors */
 476      if (quota_in > UINT32_MAX)
 477        quota_in = UINT32_MAX;
 478      if (quota_out > UINT32_MAX)
 479        quota_out = UINT32_MAX;
 480
 481      /* Compare to current bandwidth assigned */
 482      if ((quota_in != ntohl(cur->addr->assigned_bw_in.value__)) ||
 483          (quota_out != ntohl(cur->addr->assigned_bw_out.value__)))
 484      {
 485        cur->addr->assigned_bw_in.value__ = htonl (quota_in);
 486        cur->addr->assigned_bw_out.value__ = htonl (quota_out);
 487        /* Notify on change */
 488        if ((GNUNET_YES == cur->addr->active) && (cur->addr != address_except))
 489          s->bw_changed (s->bw_changed_cls, cur->addr);
 490      }
 491
 492   }
 493   LOG (GNUNET_ERROR_TYPE_DEBUG,
 494                           "Total bandwidth assigned is: (in/out): %llu /%llu\n",
 495                           quota_in_used,
 496                           quota_out_used);
 497   if (quota_out_used > quota_out)
 498     LOG (GNUNET_ERROR_TYPE_WARNING,
 499                             "DEBUG! Total inbount bandwidth assigned is larget than allowed  %llu /%llu\n",
 500                             quota_out_used,
 501                             quota_out); /* FIXME: Can happen atm, we have some rounding error */
 502   if (quota_in_used > quota_in)
 503     LOG (GNUNET_ERROR_TYPE_WARNING,
 504                             "DEBUG! Total inbount bandwidth assigned is larget than allowed  %llu /%llu\n",
 505                             quota_in_used,
 506                             quota_in); /* FIXME: Can happen atm, we have some rounding error */
 507 }
 508
 509 static void
 510 addresse_increment (struct GAS_SIMPLISTIC_Handle *s,
 511                                 struct Network *net,
 512                                 int total,
 513                                 int active)
 514 {
 515   if (GNUNET_YES == total)
 516   {
 517       s->total_addresses ++;
 518       net->total_addresses ++;
 519       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", 1, GNUNET_NO);
 520       GNUNET_STATISTICS_update (s->stats, net->stat_total, 1, GNUNET_NO);
 521   }
 522   if (GNUNET_YES == active)
 523   {
 524     net->active_addresses ++;
 525     s->active_addresses ++;
 526     GNUNET_STATISTICS_update (s->stats, "# ATS active addresses total", 1, GNUNET_NO);
 527     GNUNET_STATISTICS_update (s->stats, net->stat_active, 1, GNUNET_NO);
 528   }
 529
 530 }
 531
 532 static int
 533 addresse_decrement (struct GAS_SIMPLISTIC_Handle *s,
 534                     struct Network *net,
 535                     int total,
 536                     int active)
 537 {
 538   int res = GNUNET_OK;
 539   if (GNUNET_YES == total)
 540   {
 541     if (s->total_addresses < 1)
 542     {
 543       GNUNET_break (0);
 544       res = GNUNET_SYSERR;
 545     }
 546     else
 547     {
 548       s->total_addresses --;
 549       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
 550     }
 551     if (net->total_addresses < 1)
 552     {
 553       GNUNET_break (0);
 554       res = GNUNET_SYSERR;
 555     }
 556     else
 557     {
 558       net->total_addresses --;
 559       GNUNET_STATISTICS_update (s->stats, net->stat_total, -1, GNUNET_NO);
 560     }
 561   }
 562
 563   if (GNUNET_YES == active)
 564   {
 565     if (net->active_addresses < 1)
 566     {
 567       GNUNET_break (0);
 568       res = GNUNET_SYSERR;
 569     }
 570     else
 571     {
 572       net->active_addresses --;
 573       GNUNET_STATISTICS_update (s->stats, net->stat_active, -1, GNUNET_NO);
 574     }
 575     if (s->active_addresses < 1)
 576     {
 577       GNUNET_break (0);
 578       res = GNUNET_SYSERR;
 579     }
 580     else
 581     {
 582       s->active_addresses --;
 583       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
 584     }
 585   }
 586   return res;
 587 }
 588
 589
 590 /**
 591  * Add a single address to the solve
 592  *
 593  * @param solver the solver Handle
 594  * @param addresses the address hashmap containing all addresses
 595  * @param address the address to add
 596  */
 597 void
 598 GAS_simplistic_address_add (void *solver, struct GNUNET_CONTAINER_MultiHashMap * addresses, struct ATS_Address *address)
 599 {
 600   struct GAS_SIMPLISTIC_Handle *s = solver;
 601   struct Network *net = NULL;
 602   struct AddressWrapper *aw = NULL;
 603
 604   GNUNET_assert (NULL != s);
 605   int c;
 606   for (c = 0; c < s->networks; c++)
 607   {
 608       net = &s->network_entries[c];
 609       if (address->atsp_network_type == net->type)
 610           break;
 611   }
 612   if (NULL == net)
 613   {
 614     GNUNET_break (0);
 615     return;
 616   }
 617
 618   aw = GNUNET_malloc (sizeof (struct AddressWrapper));
 619   aw->addr = address;
 620   GNUNET_CONTAINER_DLL_insert (net->head, net->tail, aw);
 621   addresse_increment (s, net, GNUNET_YES, GNUNET_NO);
 622   aw->addr->solver_information = net;
 623
 624
 625   LOG (GNUNET_ERROR_TYPE_DEBUG, "After adding address now total %u and active %u addresses in network `%s'\n",
 626       net->total_addresses,
 627       net->active_addresses,
 628       net->desc);
 629 }
 630
 631 /**
 632  * Remove an address from the solver
 633  *
 634  * @param solver the solver handle
 635  * @param addresses the address hashmap containing all addresses
 636  * @param address the address to remove
 637  * @param session_only delete only session not whole address
 638  */
 639 void
 640 GAS_simplistic_address_delete (void *solver,
 641     struct GNUNET_CONTAINER_MultiHashMap * addresses,
 642     struct ATS_Address *address, int session_only)
 643 {
 644   struct GAS_SIMPLISTIC_Handle *s = solver;
 645   struct Network *net;
 646   struct AddressWrapper *aw;
 647
 648   /* Remove an adress completely, we have to:
 649    * - Remove from specific network
 650    * - Decrease number of total addresses
 651    * - If active:
 652    *   - decrease number of active addreses
 653    *   - update quotas
 654    */
 655
 656   net = (struct Network *) address->solver_information;
 657
 658   if (GNUNET_NO == session_only)
 659   {
 660     LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s address %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
 661         (GNUNET_NO == address->active) ? "inactive" : "active",
 662         address, GNUNET_i2s (&address->peer),
 663         net->desc, net->total_addresses, net->active_addresses);
 664
 665     /* Remove address */
 666     addresse_decrement (s, net, GNUNET_YES, GNUNET_NO);
 667     for (aw = net->head; NULL != aw; aw = aw->next)
 668     {
 669         if (aw->addr == address)
 670           break;
 671     }
 672     if (NULL == aw )
 673     {
 674         GNUNET_break (0);
 675         return;
 676     }
 677     GNUNET_CONTAINER_DLL_remove (net->head, net->tail, aw);
 678     GNUNET_free (aw);
 679   }
 680   else
 681   {
 682       /* Remove session only: remove if active and update */
 683       LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s session %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
 684           (GNUNET_NO == address->active) ? "inactive" : "active",
 685           address, GNUNET_i2s (&address->peer),
 686           net->desc, net->total_addresses, net->active_addresses);
 687   }
 688
 689   if (GNUNET_YES == address->active)
 690   {
 691       /* Address was active, remove from network and update quotas*/
 692       address->active = GNUNET_NO;
 693       if (GNUNET_SYSERR == addresse_decrement (s, net, GNUNET_NO, GNUNET_YES))
 694         GNUNET_break (0);
 695       update_quota_per_network (s, net, NULL);
 696   }
 697   LOG (GNUNET_ERROR_TYPE_DEBUG, "After deleting address now total %u and active %u addresses in network `%s'\n",
 698       net->total_addresses,
 699       net->active_addresses,
 700       net->desc);
 701
 702 }
 703
 704 static struct Network *
 705 find_network (struct GAS_SIMPLISTIC_Handle *s, uint32_t type)
 706 {
 707   int c;
 708   for (c = 0 ; c < s->networks; c++)
 709   {
 710       if (s->network_entries[c].type == type)
 711         return &s->network_entries[c];
 712   }
 713   return NULL;
 714 }
 715
 716 /**
 717  * Updates a single address in the solve
 718  *
 719  * @param solver the solver Handle
 720  * @param addresses the address hashmap containing all addresses
 721  * @param address the update address
 722  * @param session the new session (if changed otherwise current)
 723  * @param in_use the new address in use state (if changed otherwise current)
 724  * @param atsi the latest ATS information
 725  * @param atsi_count the atsi count
 726  */
 727 void
 728 GAS_simplistic_address_update (void *solver,
 729                               struct GNUNET_CONTAINER_MultiHashMap *addresses,
 730                               struct ATS_Address *address,
 731                               uint32_t session,
 732                               int in_use,
 733                               const struct GNUNET_ATS_Information *atsi,
 734                               uint32_t atsi_count)
 735 {
 736   struct ATS_Address *new;
 737   struct GAS_SIMPLISTIC_Handle *s = (struct GAS_SIMPLISTIC_Handle *) solver;
 738   int i;
 739   uint32_t value;
 740   uint32_t type;
 741   int save_active = GNUNET_NO;
 742   struct Network *new_net = NULL;
 743   for (i = 0; i < atsi_count; i++)
 744   {
 745     type = ntohl (atsi[i].type);
 746     value = ntohl (atsi[i].value);
 747     switch (type)
 748     {
 749     case GNUNET_ATS_UTILIZATION_UP:
 750       //if (address->atsp_utilization_out.value__ != atsi[i].value)
 751
 752       break;
 753     case GNUNET_ATS_UTILIZATION_DOWN:
 754       //if (address->atsp_utilization_in.value__ != atsi[i].value)
 755
 756       break;
 757     case GNUNET_ATS_QUALITY_NET_DELAY:
 758       //if (address->atsp_latency.rel_value != value)
 759
 760       break;
 761     case GNUNET_ATS_QUALITY_NET_DISTANCE:
 762       //if (address->atsp_distance != value)
 763
 764       break;
 765     case GNUNET_ATS_COST_WAN:
 766       //if (address->atsp_cost_wan != value)
 767
 768       break;
 769     case GNUNET_ATS_COST_LAN:
 770       //if (address->atsp_cost_lan != value)
 771
 772       break;
 773     case GNUNET_ATS_COST_WLAN:
 774       //if (address->atsp_cost_wlan != value)
 775
 776       break;
 777     case GNUNET_ATS_NETWORK_TYPE:
 778       if (address->atsp_network_type != value)
 779       {
 780
 781         LOG (GNUNET_ERROR_TYPE_DEBUG, "Network type changed, moving %s address from `%s' to `%s'\n",
 782             (GNUNET_YES == address->active) ? "active" : "inactive",
 783             GNUNET_ATS_print_network_type(address->atsp_network_type),
 784             GNUNET_ATS_print_network_type(value));
 785
 786         save_active = address->active;
 787         /* remove from old network */
 788         GAS_simplistic_address_delete (solver, addresses, address, GNUNET_NO);
 789
 790         /* set new network type */
 791         address->atsp_network_type = value;
 792         new_net = find_network (solver, value);
 793         address->solver_information = new_net;
 794         if (address->solver_information == NULL)
 795         {
 796             GNUNET_break (0);
 797             address->atsp_network_type = GNUNET_ATS_NET_UNSPECIFIED;
 798             return;
 799         }
 800
 801         /* Add to new network and update*/
 802         GAS_simplistic_address_add (solver, addresses, address);
 803         if (GNUNET_YES == save_active)
 804         {
 805           /* check if bandwidth available in new network */
 806           if (GNUNET_YES == (bw_available_in_network (new_net)))
 807           {
 808               /* Suggest updated address */
 809               address->active = GNUNET_YES;
 810               addresse_increment (s, new_net, GNUNET_NO, GNUNET_YES);
 811               update_quota_per_network (solver, new_net, NULL);
 812           }
 813           else
 814           {
 815             LOG (GNUNET_ERROR_TYPE_DEBUG, "Not enough bandwidth in new network, suggesting alternative address ..\n");
 816
 817             /* Set old address to zero bw */
 818             address->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0);
 819             address->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0);
 820             s->bw_changed  (s->bw_changed_cls, address);
 821
 822             /* Find new address to suggest since no bandwidth in network*/
 823             new = (struct ATS_Address *) GAS_simplistic_get_preferred_address (s, addresses, &address->peer);
 824             if (NULL != new)
 825             {
 826                 /* Have an alternative address to suggest */
 827                 s->bw_changed  (s->bw_changed_cls, new);
 828             }
 829
 830           }
 831         }
 832       }
 833       break;
 834     case GNUNET_ATS_ARRAY_TERMINATOR:
 835       break;
 836     default:
 837       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 838                   "Received unsupported ATS type %u\n", type);
 839       GNUNET_break (0);
 840       break;
 841
 842     }
 843
 844   }
 845   if (address->session_id != session)
 846   {
 847       LOG (GNUNET_ERROR_TYPE_DEBUG,
 848                   "Session changed from %u to %u\n", address->session_id, session);
 849       address->session_id = session;
 850   }
 851   if (address->used != in_use)
 852   {
 853       LOG (GNUNET_ERROR_TYPE_DEBUG,
 854                   "Usage changed from %u to %u\n", address->used, in_use);
 855       address->used = in_use;
 856   }
 857
 858 }
 859
 860
 861
 862 /**
 863  * Find a "good" address to use for a peer.  If we already have an existing
 864  * address, we stick to it.  Otherwise, we pick by lowest distance and then
 865  * by lowest latency.
 866  *
 867  * @param cls the 'struct ATS_Address**' where we store the result
 868  * @param key unused
 869  * @param value another 'struct ATS_Address*' to consider using
 870  * @return GNUNET_OK (continue to iterate)
 871  */
 872 static int
 873 find_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
 874 {
 875   struct ATS_Address **previous_p = cls;
 876   struct ATS_Address *current = (struct ATS_Address *) value;
 877   struct ATS_Address *previous = *previous_p;
 878   struct GNUNET_TIME_Absolute now;
 879   struct Network *net = (struct Network *) current->solver_information;
 880
 881   now = GNUNET_TIME_absolute_get();
 882
 883   if (current->blocked_until.abs_value == GNUNET_TIME_absolute_max (now, current->blocked_until).abs_value)
 884   {
 885     /* This address is blocked for suggestion */
 886     LOG (GNUNET_ERROR_TYPE_DEBUG,
 887                 "Address %p blocked for suggestion for %llu ms \n",
 888                 current,
 889                 GNUNET_TIME_absolute_get_difference(now, current->blocked_until).rel_value);
 890     return GNUNET_OK;
 891   }
 892
 893   if (GNUNET_NO == bw_available_in_network (net))
 894     return GNUNET_OK; /* There's no bandwidth available in this network */
 895
 896   if (NULL != previous)
 897   {
 898     if ((0 == strcmp (previous->plugin, "tcp")) &&
 899         (0 == strcmp (current->plugin, "tcp")))
 900     {
 901       if ((0 != previous->addr_len) &&
 902           (0 == current->addr_len))
 903       {
 904         /* saved address was an outbound address, but we have an inbound address */
 905         *previous_p = current;
 906         return GNUNET_OK;
 907       }
 908       if (0 == previous->addr_len)
 909       {
 910         /* saved address was an inbound address, so do not overwrite */
 911         return GNUNET_OK;
 912       }
 913     }
 914   }
 915
 916   if (NULL == previous)
 917   {
 918     *previous_p = current;
 919     return GNUNET_OK;
 920   }
 921   if ((ntohl (previous->assigned_bw_in.value__) == 0) &&
 922       (ntohl (current->assigned_bw_in.value__) > 0))
 923   {
 924     /* stick to existing connection */
 925     *previous_p = current;
 926     return GNUNET_OK;
 927   }
 928   if (previous->atsp_distance > current->atsp_distance)
 929   {
 930     /* user shorter distance */
 931     *previous_p = current;
 932     return GNUNET_OK;
 933   }
 934   if (previous->atsp_latency.rel_value > current->atsp_latency.rel_value)
 935   {
 936     /* user lower latency */
 937     *previous_p = current;
 938     return GNUNET_OK;
 939   }
 940   /* don't care */
 941   return GNUNET_OK;
 942 }
 943
 944 static int
 945 find_active_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
 946 {
 947   struct ATS_Address * dest = (struct ATS_Address *) (*(struct ATS_Address **)cls);
 948   struct ATS_Address * aa = (struct ATS_Address *) value;
 949
 950   if (GNUNET_YES == aa->active)
 951   {
 952       if (dest != NULL)
 953       {
 954           /* should never happen */
 955           LOG (GNUNET_ERROR_TYPE_ERROR, "Multiple active addresses for peer `%s'\n", GNUNET_i2s (&aa->peer));
 956           GNUNET_break (0);
 957           return GNUNET_NO;
 958       }
 959       dest = aa;
 960   }
 961   return GNUNET_OK;
 962 }
 963
 964 static struct ATS_Address *
 965 find_active_address (void *solver,
 966                      struct GNUNET_CONTAINER_MultiHashMap * addresses,
 967                      const struct GNUNET_PeerIdentity *peer)
 968 {
 969   struct ATS_Address * dest = NULL;
 970
 971   GNUNET_CONTAINER_multihashmap_get_multiple(addresses,
 972        &peer->hashPubKey,
 973        &find_active_address_it, &dest);
 974   return dest;
 975 }
 976
 977 /**
 978  * Get the prefered address for a specific peer
 979  *
 980  * @param solver the solver handle
 981  * @param addresses the address hashmap containing all addresses
 982  * @param peer the identity of the peer
 983  */
 984 const struct ATS_Address *
 985 GAS_simplistic_get_preferred_address (void *solver,
 986                                struct GNUNET_CONTAINER_MultiHashMap * addresses,
 987                                const struct GNUNET_PeerIdentity *peer)
 988 {
 989   struct GAS_SIMPLISTIC_Handle *s = solver;
 990   struct Network *net_prev;
 991   struct Network *net_cur;
 992   struct ATS_Address *cur;
 993   struct ATS_Address *prev;
 994
 995   GNUNET_assert (s != NULL);
 996   cur = NULL;
 997   /* Get address with: stick to current address, lower distance, lower latency */
 998   GNUNET_CONTAINER_multihashmap_get_multiple (addresses, &peer->hashPubKey,
 999                                               &find_address_it, &cur);
1000   if (NULL == cur)
1001   {
1002     LOG (GNUNET_ERROR_TYPE_DEBUG, "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
1003     return NULL;
1004   }
1005
1006   LOG (GNUNET_ERROR_TYPE_DEBUG, "Suggesting %s address %p for peer `%s'\n",
1007       (GNUNET_NO == cur->active) ? "inactive" : "active",
1008       cur, GNUNET_i2s (peer));
1009   net_cur = (struct Network *) cur->solver_information;
1010   if (GNUNET_YES == cur->active)
1011   {
1012       /* This address was selected previously, so no need to update quotas */
1013       return cur;
1014   }
1015
1016   /* This address was not active, so we have to:
1017    *
1018    * - mark previous active address as not active
1019    * - update quota for previous address network
1020    * - update quota for this address network
1021    */
1022
1023   prev = find_active_address (s, addresses, peer);
1024   if (NULL != prev)
1025   {
1026       net_prev = (struct Network *) prev->solver_information;
1027       prev->active = GNUNET_NO; /* No active any longer */
1028       prev->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0); /* no bw assigned */
1029       prev->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0); /* no bw assigned */
1030       s->bw_changed (s->bw_changed_cls, prev); /* notify about bw change, REQUIRED? */
1031       if (GNUNET_SYSERR == addresse_decrement (s, net_prev, GNUNET_NO, GNUNET_YES))
1032         GNUNET_break (0);
1033       update_quota_per_network (s, net_prev, NULL);
1034   }
1035
1036   if (GNUNET_NO == (bw_available_in_network (cur->solver_information)))
1037   {
1038     GNUNET_break (0); /* This should never happen*/
1039     return NULL;
1040   }
1041
1042   cur->active = GNUNET_YES;
1043   addresse_increment(s, net_cur, GNUNET_NO, GNUNET_YES);
1044   update_quota_per_network (s, net_cur, cur);
1045
1046   return cur;
1047 }
1048
1049 /**
1050  * Changes the preferences for a peer in the problem
1051  *
1052  * @param solver the solver handle
1053  * @param client the client with this preference
1054  * @param peer the peer to change the preference for
1055  * @param kind the kind to change the preference
1056  * @param score the score
1057  */
1058 void
1059 GAS_simplistic_address_change_preference (void *solver,
1060                                    void *client,
1061                                    const struct GNUNET_PeerIdentity *peer,
1062                                    enum GNUNET_ATS_PreferenceKind kind,
1063                                    float score)
1064 {
1065   static struct GNUNET_TIME_Absolute next_update;
1066   struct GAS_SIMPLISTIC_Handle *s = solver;
1067   struct PreferenceClient *cur;
1068   struct PreferencePeer *p;
1069   int i;
1070   int clients;
1071   float p_rel_global;
1072   float *dest;
1073
1074
1075   GNUNET_assert (NULL != solver);
1076   GNUNET_assert (NULL != client);
1077   GNUNET_assert (NULL != peer);
1078
1079   LOG (GNUNET_ERROR_TYPE_DEBUG, "Client %p changes preference for peer `%s' %s %f\n",
1080                                 client,
1081                                 GNUNET_i2s (peer),
1082                                 GNUNET_ATS_print_preference_type (kind),
1083                                 score);
1084
1085   if (kind >= GNUNET_ATS_PreferenceCount)
1086   {
1087       GNUNET_break (0);
1088       return;
1089   }
1090
1091   /**
1092    * Idea:
1093    *
1094    * We have:
1095    * Set of clients c
1096    * Set of peers p_i in P
1097    * Set of preference kinds k
1098    * A preference value f_k_p_i with an unknown range
1099    *
1100    * We get:
1101    * A client specific relative preference f_p_i_rel [1..2] for all peers
1102    *
1103    * For every client c
1104    * {
1105    *   For every preference kind k:
1106    *   {
1107    *     We remember for the preference f_p_i for each peer p_i.
1108    *     We have a default preference value f_p_i = 0
1109    *     We have a sum of all preferences f_t = sum (f_p_i)
1110    *     So we can calculate a relative preference value fr_p_i:
1111    *
1112    *     f_k_p_i_rel = (f_t + f_p_i) / f_t
1113    *     f_k_p_i_rel = [1..2], default 1.0
1114    *    }
1115    *    f_p_i_rel = sum (f_k_p_i_rel) / #k
1116    * }
1117    *
1118    **/
1119
1120   /* Find preference client */
1121   for (cur = s->pc_head; NULL != cur; cur = cur->next)
1122   {
1123       if (client == cur->client)
1124         break;
1125   }
1126   /* Not found: create new preference client */
1127   if (NULL == cur)
1128   {
1129     cur = GNUNET_malloc (sizeof (struct PreferenceClient));
1130     cur->client = client;
1131     GNUNET_CONTAINER_DLL_insert (s->pc_head, s->pc_tail, cur);
1132   }
1133
1134   /* Find entry for peer */
1135   for (p = cur->p_head; NULL != p; p = p->next)
1136     if (0 == memcmp (&p->id, peer, sizeof (p->id)))
1137         break;
1138
1139   /* Not found: create new peer entry */
1140   if (NULL == p)
1141   {
1142       p = GNUNET_malloc (sizeof (struct PreferencePeer));
1143       p->id = (*peer);
1144       for (i = 0; i < GNUNET_ATS_PreferenceCount; i++)
1145       {
1146         /* Default value per peer absolut preference for a quality:
1147          * No value set, so absolute preference 0 */
1148         p->f[i] = 0.0;
1149         /* Default value per peer relative preference for a quality: 1.0 */
1150         p->f_rel[i] = DEFAULT_PREFERENCE;
1151       }
1152       GNUNET_CONTAINER_DLL_insert (cur->p_head, cur->p_tail, p);
1153   }
1154
1155   /* Update preference value according to type */
1156   switch (kind) {
1157     case GNUNET_ATS_PREFERENCE_BANDWIDTH:
1158     case GNUNET_ATS_PREFERENCE_LATENCY:
1159       p->f[kind] = (p->f[kind] + score) / 2;
1160       break;
1161     case GNUNET_ATS_PREFERENCE_END:
1162       break;
1163     default:
1164       break;
1165   }
1166
1167   /* Recalcalculate total preference for this quality kind over all peers*/
1168   cur->f_total[kind] = 0;
1169   for (p = cur->p_head; NULL != p; p = p->next)
1170     cur->f_total[kind] += p->f[kind];
1171
1172   LOG (GNUNET_ERROR_TYPE_DEBUG, "Client %p has total preference for %s of %.3f\n",
1173       cur->client,
1174       GNUNET_ATS_print_preference_type (kind),
1175       cur->f_total[kind]);
1176
1177   /* Recalcalculate relative preference for all peers */
1178   for (p = cur->p_head; NULL != p; p = p->next)
1179   {
1180     /* Calculate relative preference for specific kind */
1181     p->f_rel[kind] = (cur->f_total[kind] + p->f[kind]) / cur->f_total[kind];
1182     LOG (GNUNET_ERROR_TYPE_DEBUG, "Client %p: peer `%s' has relative preference for %s of %.3f\n",
1183         cur->client,
1184         GNUNET_i2s (&p->id),
1185         GNUNET_ATS_print_preference_type (kind),
1186         p->f_rel[kind]);
1187
1188     /* Calculate peer relative preference
1189      * Start with i = 1 to exclude terminator */
1190     p->f_rel_total = 0;
1191     for (i = 1; i < GNUNET_ATS_PreferenceCount; i ++)
1192     {
1193         p->f_rel_total += p->f_rel[i];
1194     }
1195     p->f_rel_total /=  (GNUNET_ATS_PreferenceCount - 1.0); /* -1 due to terminator */
1196     LOG (GNUNET_ERROR_TYPE_DEBUG, "Client %p: peer `%s' has total relative preference of %.3f\n",
1197         cur->client,
1198         GNUNET_i2s (&p->id),
1199         p->f_rel_total);
1200   }
1201
1202   /* Calculcate global total relative peer preference over all clients */
1203   p_rel_global = 0.0;
1204   clients = 0;
1205   for (cur = s->pc_head; NULL != cur; cur = cur->next)
1206   {
1207       for (p = cur->p_head; NULL != p; p = p->next)
1208           if (0 == memcmp (&p->id, peer, sizeof (p->id)))
1209               break;
1210       if (NULL != p)
1211       {
1212           clients++;
1213           p_rel_global += p->f_rel_total;
1214       }
1215   }
1216   p_rel_global /= clients;
1217   LOG (GNUNET_ERROR_TYPE_DEBUG, "Global preference value for peer `%s': %.3f\n",
1218       GNUNET_i2s (peer), p_rel_global);
1219
1220   /* Update global map */
1221   /* FIXME: We should update all peers since they have influence on each other */
1222   if (NULL != (dest = GNUNET_CONTAINER_multihashmap_get(s->prefs, &peer->hashPubKey)))
1223       (*dest) = p_rel_global;
1224   else
1225   {
1226       dest = GNUNET_malloc (sizeof (float));
1227       (*dest) = p_rel_global;
1228       GNUNET_CONTAINER_multihashmap_put(s->prefs,
1229           &peer->hashPubKey,
1230           dest,
1231           GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
1232   }
1233
1234   /* FIXME: We should update quotas if UPDATE_INTERVAL is reached */
1235   if (GNUNET_TIME_absolute_get().abs_value > next_update.abs_value)
1236   {
1237       /* update quotas*/
1238       next_update = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(),
1239                                               MIN_UPDATE_INTERVAL);
1240   }
1241
1242 }
1243
1244 /* end of gnunet-service-ats_addresses_simplistic.c */