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 quota_in = 0;
 406   unsigned long long quota_out = 0;
 407   struct AddressWrapper *cur;
 408
 409   LOG (GNUNET_ERROR_TYPE_DEBUG,
 410               "Recalculate quota for network type `%s' for %u addresses (in/out): %llu/%llu \n",
 411               net->desc, net->active_addresses, quota_in, quota_out);
 412
 413   if (net->active_addresses == 0)
 414     return; /* no addresses to update */
 415
 416   /* Idea TODO
 417    *
 418    * Assign every peer in network minimum Bandwidth
 419    * Distribute bandwidth left according to preference
 420    */
 421   unsigned long long remaining_quota_in = 0;
 422   unsigned long long quota_out_used = 0;
 423
 424   unsigned long long remaining_quota_out = 0;
 425   unsigned long long quota_in_used = 0;
 426   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
 427   float total_prefs;
 428   float cur_pref = 0.0;
 429   float *t = NULL;
 430
 431   remaining_quota_in = net->total_quota_in - (net->active_addresses * min_bw);
 432   remaining_quota_out = net->total_quota_out - (net->active_addresses * min_bw);
 433   total_prefs = 0.0;
 434   LOG (GNUNET_ERROR_TYPE_ERROR, "Remaining bandwidth : (in/out): %llu/%llu \n",
 435               remaining_quota_in, remaining_quota_out);
 436   for (cur = net->head; NULL != cur; cur = cur->next)
 437   {
 438      t = GNUNET_CONTAINER_multihashmap_get (s->prefs, &cur->addr->peer.hashPubKey);
 439      if (NULL == t)
 440        total_prefs += DEFAULT_PREFERENCE;
 441      else
 442        total_prefs += (*t);
 443   }
 444   for (cur = net->head; NULL != cur; cur = cur->next)
 445   {
 446      t = GNUNET_CONTAINER_multihashmap_get (s->prefs, &cur->addr->peer.hashPubKey);
 447      if (NULL == t)
 448        cur_pref = DEFAULT_PREFERENCE;
 449      else
 450        cur_pref = (*t);
 451      quota_in = min_bw + (cur_pref / total_prefs) * (float) remaining_quota_in;
 452      quota_out = min_bw + (cur_pref / total_prefs) * (float) remaining_quota_out;
 453      LOG (GNUNET_ERROR_TYPE_ERROR,
 454                  "New quota for peer `%s' with preference (cur/total) %.3f/%.3f (in/out): %llu /%llu\n",
 455                  GNUNET_i2s (&cur->addr->peer),
 456                  cur_pref,
 457                  total_prefs,
 458                  quota_in,
 459                  quota_out);
 460      quota_in_used += quota_in;
 461      quota_out_used += quota_out;
 462
 463   }
 464   LOG (GNUNET_ERROR_TYPE_ERROR,
 465               "Total quota would be: (in/out): %llu /%llu\n",
 466               quota_in,
 467               quota_out);
 468   LOG (GNUNET_ERROR_TYPE_ERROR,
 469                           "New quota would be: (in/out): %llu /%llu\n",
 470                           quota_in_used,
 471                           quota_out_used);
 472
 473   LOG (GNUNET_ERROR_TYPE_DEBUG,
 474               "New per address quota for network type `%s' for %u addresses (in/out): %llu/%llu \n",
 475               net->desc, net->active_addresses, quota_in, quota_out);
 476
 477   cur = net->head;
 478   while (NULL != cur)
 479   {
 480       /* Compare to current bandwidth assigned */
 481       if ((quota_in != ntohl(cur->addr->assigned_bw_in.value__)) ||
 482           (quota_out != ntohl(cur->addr->assigned_bw_out.value__)))
 483       {
 484         cur->addr->assigned_bw_in.value__ = htonl (quota_in);
 485         cur->addr->assigned_bw_out.value__ = htonl (quota_out);
 486         /* Notify on change */
 487         if ((GNUNET_YES == cur->addr->active) && (cur->addr != address_except))
 488           s->bw_changed (s->bw_changed_cls, cur->addr);
 489       }
 490       cur = cur->next;
 491   }
 492 }
 493
 494 static void
 495 addresse_increment (struct GAS_SIMPLISTIC_Handle *s,
 496                                 struct Network *net,
 497                                 int total,
 498                                 int active)
 499 {
 500   if (GNUNET_YES == total)
 501   {
 502       s->total_addresses ++;
 503       net->total_addresses ++;
 504       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", 1, GNUNET_NO);
 505       GNUNET_STATISTICS_update (s->stats, net->stat_total, 1, GNUNET_NO);
 506   }
 507   if (GNUNET_YES == active)
 508   {
 509     net->active_addresses ++;
 510     s->active_addresses ++;
 511     GNUNET_STATISTICS_update (s->stats, "# ATS active addresses total", 1, GNUNET_NO);
 512     GNUNET_STATISTICS_update (s->stats, net->stat_active, 1, GNUNET_NO);
 513   }
 514
 515 }
 516
 517 static int
 518 addresse_decrement (struct GAS_SIMPLISTIC_Handle *s,
 519                     struct Network *net,
 520                     int total,
 521                     int active)
 522 {
 523   int res = GNUNET_OK;
 524   if (GNUNET_YES == total)
 525   {
 526     if (s->total_addresses < 1)
 527     {
 528       GNUNET_break (0);
 529       res = GNUNET_SYSERR;
 530     }
 531     else
 532     {
 533       s->total_addresses --;
 534       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
 535     }
 536     if (net->total_addresses < 1)
 537     {
 538       GNUNET_break (0);
 539       res = GNUNET_SYSERR;
 540     }
 541     else
 542     {
 543       net->total_addresses --;
 544       GNUNET_STATISTICS_update (s->stats, net->stat_total, -1, GNUNET_NO);
 545     }
 546   }
 547
 548   if (GNUNET_YES == active)
 549   {
 550     if (net->active_addresses < 1)
 551     {
 552       GNUNET_break (0);
 553       res = GNUNET_SYSERR;
 554     }
 555     else
 556     {
 557       net->active_addresses --;
 558       GNUNET_STATISTICS_update (s->stats, net->stat_active, -1, GNUNET_NO);
 559     }
 560     if (s->active_addresses < 1)
 561     {
 562       GNUNET_break (0);
 563       res = GNUNET_SYSERR;
 564     }
 565     else
 566     {
 567       s->active_addresses --;
 568       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
 569     }
 570   }
 571   return res;
 572 }
 573
 574
 575 /**
 576  * Add a single address to the solve
 577  *
 578  * @param solver the solver Handle
 579  * @param addresses the address hashmap containing all addresses
 580  * @param address the address to add
 581  */
 582 void
 583 GAS_simplistic_address_add (void *solver, struct GNUNET_CONTAINER_MultiHashMap * addresses, struct ATS_Address *address)
 584 {
 585   struct GAS_SIMPLISTIC_Handle *s = solver;
 586   struct Network *net = NULL;
 587   struct AddressWrapper *aw = NULL;
 588
 589   GNUNET_assert (NULL != s);
 590   int c;
 591   for (c = 0; c < s->networks; c++)
 592   {
 593       net = &s->network_entries[c];
 594       if (address->atsp_network_type == net->type)
 595           break;
 596   }
 597   if (NULL == net)
 598   {
 599     GNUNET_break (0);
 600     return;
 601   }
 602
 603   aw = GNUNET_malloc (sizeof (struct AddressWrapper));
 604   aw->addr = address;
 605   GNUNET_CONTAINER_DLL_insert (net->head, net->tail, aw);
 606   addresse_increment (s, net, GNUNET_YES, GNUNET_NO);
 607   aw->addr->solver_information = net;
 608
 609
 610   LOG (GNUNET_ERROR_TYPE_DEBUG, "After adding address now total %u and active %u addresses in network `%s'\n",
 611       net->total_addresses,
 612       net->active_addresses,
 613       net->desc);
 614 }
 615
 616 /**
 617  * Remove an address from the solver
 618  *
 619  * @param solver the solver handle
 620  * @param addresses the address hashmap containing all addresses
 621  * @param address the address to remove
 622  * @param session_only delete only session not whole address
 623  */
 624 void
 625 GAS_simplistic_address_delete (void *solver,
 626     struct GNUNET_CONTAINER_MultiHashMap * addresses,
 627     struct ATS_Address *address, int session_only)
 628 {
 629   struct GAS_SIMPLISTIC_Handle *s = solver;
 630   struct Network *net;
 631   struct AddressWrapper *aw;
 632
 633   /* Remove an adress completely, we have to:
 634    * - Remove from specific network
 635    * - Decrease number of total addresses
 636    * - If active:
 637    *   - decrease number of active addreses
 638    *   - update quotas
 639    */
 640
 641   net = (struct Network *) address->solver_information;
 642
 643   if (GNUNET_NO == session_only)
 644   {
 645     LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s address %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
 646         (GNUNET_NO == address->active) ? "inactive" : "active",
 647         address, GNUNET_i2s (&address->peer),
 648         net->desc, net->total_addresses, net->active_addresses);
 649
 650     /* Remove address */
 651     addresse_decrement (s, net, GNUNET_YES, GNUNET_NO);
 652     for (aw = net->head; NULL != aw; aw = aw->next)
 653     {
 654         if (aw->addr == address)
 655           break;
 656     }
 657     if (NULL == aw )
 658     {
 659         GNUNET_break (0);
 660         return;
 661     }
 662     GNUNET_CONTAINER_DLL_remove (net->head, net->tail, aw);
 663     GNUNET_free (aw);
 664   }
 665   else
 666   {
 667       /* Remove session only: remove if active and update */
 668       LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s session %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
 669           (GNUNET_NO == address->active) ? "inactive" : "active",
 670           address, GNUNET_i2s (&address->peer),
 671           net->desc, net->total_addresses, net->active_addresses);
 672   }
 673
 674   if (GNUNET_YES == address->active)
 675   {
 676       /* Address was active, remove from network and update quotas*/
 677       address->active = GNUNET_NO;
 678       if (GNUNET_SYSERR == addresse_decrement (s, net, GNUNET_NO, GNUNET_YES))
 679         GNUNET_break (0);
 680       update_quota_per_network (s, net, NULL);
 681   }
 682   LOG (GNUNET_ERROR_TYPE_DEBUG, "After deleting address now total %u and active %u addresses in network `%s'\n",
 683       net->total_addresses,
 684       net->active_addresses,
 685       net->desc);
 686
 687 }
 688
 689 static struct Network *
 690 find_network (struct GAS_SIMPLISTIC_Handle *s, uint32_t type)
 691 {
 692   int c;
 693   for (c = 0 ; c < s->networks; c++)
 694   {
 695       if (s->network_entries[c].type == type)
 696         return &s->network_entries[c];
 697   }
 698   return NULL;
 699 }
 700
 701 /**
 702  * Updates a single address in the solve
 703  *
 704  * @param solver the solver Handle
 705  * @param addresses the address hashmap containing all addresses
 706  * @param address the update address
 707  * @param session the new session (if changed otherwise current)
 708  * @param in_use the new address in use state (if changed otherwise current)
 709  * @param atsi the latest ATS information
 710  * @param atsi_count the atsi count
 711  */
 712 void
 713 GAS_simplistic_address_update (void *solver,
 714                               struct GNUNET_CONTAINER_MultiHashMap *addresses,
 715                               struct ATS_Address *address,
 716                               uint32_t session,
 717                               int in_use,
 718                               const struct GNUNET_ATS_Information *atsi,
 719                               uint32_t atsi_count)
 720 {
 721   struct ATS_Address *new;
 722   struct GAS_SIMPLISTIC_Handle *s = (struct GAS_SIMPLISTIC_Handle *) solver;
 723   int i;
 724   uint32_t value;
 725   uint32_t type;
 726   int save_active = GNUNET_NO;
 727   struct Network *new_net = NULL;
 728   for (i = 0; i < atsi_count; i++)
 729   {
 730     type = ntohl (atsi[i].type);
 731     value = ntohl (atsi[i].value);
 732     switch (type)
 733     {
 734     case GNUNET_ATS_UTILIZATION_UP:
 735       //if (address->atsp_utilization_out.value__ != atsi[i].value)
 736
 737       break;
 738     case GNUNET_ATS_UTILIZATION_DOWN:
 739       //if (address->atsp_utilization_in.value__ != atsi[i].value)
 740
 741       break;
 742     case GNUNET_ATS_QUALITY_NET_DELAY:
 743       //if (address->atsp_latency.rel_value != value)
 744
 745       break;
 746     case GNUNET_ATS_QUALITY_NET_DISTANCE:
 747       //if (address->atsp_distance != value)
 748
 749       break;
 750     case GNUNET_ATS_COST_WAN:
 751       //if (address->atsp_cost_wan != value)
 752
 753       break;
 754     case GNUNET_ATS_COST_LAN:
 755       //if (address->atsp_cost_lan != value)
 756
 757       break;
 758     case GNUNET_ATS_COST_WLAN:
 759       //if (address->atsp_cost_wlan != value)
 760
 761       break;
 762     case GNUNET_ATS_NETWORK_TYPE:
 763       if (address->atsp_network_type != value)
 764       {
 765
 766         LOG (GNUNET_ERROR_TYPE_DEBUG, "Network type changed, moving %s address from `%s' to `%s'\n",
 767             (GNUNET_YES == address->active) ? "active" : "inactive",
 768             GNUNET_ATS_print_network_type(address->atsp_network_type),
 769             GNUNET_ATS_print_network_type(value));
 770
 771         save_active = address->active;
 772         /* remove from old network */
 773         GAS_simplistic_address_delete (solver, addresses, address, GNUNET_NO);
 774
 775         /* set new network type */
 776         address->atsp_network_type = value;
 777         new_net = find_network (solver, value);
 778         address->solver_information = new_net;
 779         if (address->solver_information == NULL)
 780         {
 781             GNUNET_break (0);
 782             address->atsp_network_type = GNUNET_ATS_NET_UNSPECIFIED;
 783             return;
 784         }
 785
 786         /* Add to new network and update*/
 787         GAS_simplistic_address_add (solver, addresses, address);
 788         if (GNUNET_YES == save_active)
 789         {
 790           /* check if bandwidth available in new network */
 791           if (GNUNET_YES == (bw_available_in_network (new_net)))
 792           {
 793               /* Suggest updated address */
 794               address->active = GNUNET_YES;
 795               addresse_increment (s, new_net, GNUNET_NO, GNUNET_YES);
 796               update_quota_per_network (solver, new_net, NULL);
 797           }
 798           else
 799           {
 800             LOG (GNUNET_ERROR_TYPE_DEBUG, "Not enough bandwidth in new network, suggesting alternative address ..\n");
 801
 802             /* Set old address to zero bw */
 803             address->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0);
 804             address->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0);
 805             s->bw_changed  (s->bw_changed_cls, address);
 806
 807             /* Find new address to suggest since no bandwidth in network*/
 808             new = (struct ATS_Address *) GAS_simplistic_get_preferred_address (s, addresses, &address->peer);
 809             if (NULL != new)
 810             {
 811                 /* Have an alternative address to suggest */
 812                 s->bw_changed  (s->bw_changed_cls, new);
 813             }
 814
 815           }
 816         }
 817       }
 818       break;
 819     case GNUNET_ATS_ARRAY_TERMINATOR:
 820       break;
 821     default:
 822       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 823                   "Received unsupported ATS type %u\n", type);
 824       GNUNET_break (0);
 825       break;
 826
 827     }
 828
 829   }
 830   if (address->session_id != session)
 831   {
 832       LOG (GNUNET_ERROR_TYPE_DEBUG,
 833                   "Session changed from %u to %u\n", address->session_id, session);
 834       address->session_id = session;
 835   }
 836   if (address->used != in_use)
 837   {
 838       LOG (GNUNET_ERROR_TYPE_DEBUG,
 839                   "Usage changed from %u to %u\n", address->used, in_use);
 840       address->used = in_use;
 841   }
 842
 843 }
 844
 845
 846
 847 /**
 848  * Find a "good" address to use for a peer.  If we already have an existing
 849  * address, we stick to it.  Otherwise, we pick by lowest distance and then
 850  * by lowest latency.
 851  *
 852  * @param cls the 'struct ATS_Address**' where we store the result
 853  * @param key unused
 854  * @param value another 'struct ATS_Address*' to consider using
 855  * @return GNUNET_OK (continue to iterate)
 856  */
 857 static int
 858 find_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
 859 {
 860   struct ATS_Address **previous_p = cls;
 861   struct ATS_Address *current = (struct ATS_Address *) value;
 862   struct ATS_Address *previous = *previous_p;
 863   struct GNUNET_TIME_Absolute now;
 864   struct Network *net = (struct Network *) current->solver_information;
 865
 866   now = GNUNET_TIME_absolute_get();
 867
 868   if (current->blocked_until.abs_value == GNUNET_TIME_absolute_max (now, current->blocked_until).abs_value)
 869   {
 870     /* This address is blocked for suggestion */
 871     LOG (GNUNET_ERROR_TYPE_DEBUG,
 872                 "Address %p blocked for suggestion for %llu ms \n",
 873                 current,
 874                 GNUNET_TIME_absolute_get_difference(now, current->blocked_until).rel_value);
 875     return GNUNET_OK;
 876   }
 877
 878   if (GNUNET_NO == bw_available_in_network (net))
 879     return GNUNET_OK; /* There's no bandwidth available in this network */
 880
 881   if (NULL != previous)
 882   {
 883     if ((0 == strcmp (previous->plugin, "tcp")) &&
 884         (0 == strcmp (current->plugin, "tcp")))
 885     {
 886       if ((0 != previous->addr_len) &&
 887           (0 == current->addr_len))
 888       {
 889         /* saved address was an outbound address, but we have an inbound address */
 890         *previous_p = current;
 891         return GNUNET_OK;
 892       }
 893       if (0 == previous->addr_len)
 894       {
 895         /* saved address was an inbound address, so do not overwrite */
 896         return GNUNET_OK;
 897       }
 898     }
 899   }
 900
 901   if (NULL == previous)
 902   {
 903     *previous_p = current;
 904     return GNUNET_OK;
 905   }
 906   if ((ntohl (previous->assigned_bw_in.value__) == 0) &&
 907       (ntohl (current->assigned_bw_in.value__) > 0))
 908   {
 909     /* stick to existing connection */
 910     *previous_p = current;
 911     return GNUNET_OK;
 912   }
 913   if (previous->atsp_distance > current->atsp_distance)
 914   {
 915     /* user shorter distance */
 916     *previous_p = current;
 917     return GNUNET_OK;
 918   }
 919   if (previous->atsp_latency.rel_value > current->atsp_latency.rel_value)
 920   {
 921     /* user lower latency */
 922     *previous_p = current;
 923     return GNUNET_OK;
 924   }
 925   /* don't care */
 926   return GNUNET_OK;
 927 }
 928
 929 static int
 930 find_active_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
 931 {
 932   struct ATS_Address * dest = (struct ATS_Address *) (*(struct ATS_Address **)cls);
 933   struct ATS_Address * aa = (struct ATS_Address *) value;
 934
 935   if (GNUNET_YES == aa->active)
 936   {
 937       if (dest != NULL)
 938       {
 939           /* should never happen */
 940           LOG (GNUNET_ERROR_TYPE_ERROR, "Multiple active addresses for peer `%s'\n", GNUNET_i2s (&aa->peer));
 941           GNUNET_break (0);
 942           return GNUNET_NO;
 943       }
 944       dest = aa;
 945   }
 946   return GNUNET_OK;
 947 }
 948
 949 static struct ATS_Address *
 950 find_active_address (void *solver,
 951                      struct GNUNET_CONTAINER_MultiHashMap * addresses,
 952                      const struct GNUNET_PeerIdentity *peer)
 953 {
 954   struct ATS_Address * dest = NULL;
 955
 956   GNUNET_CONTAINER_multihashmap_get_multiple(addresses,
 957        &peer->hashPubKey,
 958        &find_active_address_it, &dest);
 959   return dest;
 960 }
 961
 962 /**
 963  * Get the prefered address for a specific peer
 964  *
 965  * @param solver the solver handle
 966  * @param addresses the address hashmap containing all addresses
 967  * @param peer the identity of the peer
 968  */
 969 const struct ATS_Address *
 970 GAS_simplistic_get_preferred_address (void *solver,
 971                                struct GNUNET_CONTAINER_MultiHashMap * addresses,
 972                                const struct GNUNET_PeerIdentity *peer)
 973 {
 974   struct GAS_SIMPLISTIC_Handle *s = solver;
 975   struct Network *net_prev;
 976   struct Network *net_cur;
 977   struct ATS_Address *cur;
 978   struct ATS_Address *prev;
 979
 980   GNUNET_assert (s != NULL);
 981   cur = NULL;
 982   /* Get address with: stick to current address, lower distance, lower latency */
 983   GNUNET_CONTAINER_multihashmap_get_multiple (addresses, &peer->hashPubKey,
 984                                               &find_address_it, &cur);
 985   if (NULL == cur)
 986   {
 987     LOG (GNUNET_ERROR_TYPE_DEBUG, "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
 988     return NULL;
 989   }
 990
 991   LOG (GNUNET_ERROR_TYPE_DEBUG, "Suggesting %s address %p for peer `%s'\n",
 992       (GNUNET_NO == cur->active) ? "inactive" : "active",
 993       cur, GNUNET_i2s (peer));
 994   net_cur = (struct Network *) cur->solver_information;
 995   if (GNUNET_YES == cur->active)
 996   {
 997       /* This address was selected previously, so no need to update quotas */
 998       return cur;
 999   }
1000
1001   /* This address was not active, so we have to:
1002    *
1003    * - mark previous active address as not active
1004    * - update quota for previous address network
1005    * - update quota for this address network
1006    */
1007
1008   prev = find_active_address (s, addresses, peer);
1009   if (NULL != prev)
1010   {
1011       net_prev = (struct Network *) prev->solver_information;
1012       prev->active = GNUNET_NO; /* No active any longer */
1013       prev->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0); /* no bw assigned */
1014       prev->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0); /* no bw assigned */
1015       s->bw_changed (s->bw_changed_cls, prev); /* notify about bw change, REQUIRED? */
1016       if (GNUNET_SYSERR == addresse_decrement (s, net_prev, GNUNET_NO, GNUNET_YES))
1017         GNUNET_break (0);
1018       update_quota_per_network (s, net_prev, NULL);
1019   }
1020
1021   if (GNUNET_NO == (bw_available_in_network (cur->solver_information)))
1022   {
1023     GNUNET_break (0); /* This should never happen*/
1024     return NULL;
1025   }
1026
1027   cur->active = GNUNET_YES;
1028   addresse_increment(s, net_cur, GNUNET_NO, GNUNET_YES);
1029   update_quota_per_network (s, net_cur, cur);
1030
1031   return cur;
1032 }
1033
1034 /**
1035  * Changes the preferences for a peer in the problem
1036  *
1037  * @param solver the solver handle
1038  * @param client the client with this preference
1039  * @param peer the peer to change the preference for
1040  * @param kind the kind to change the preference
1041  * @param score the score
1042  */
1043 void
1044 GAS_simplistic_address_change_preference (void *solver,
1045                                    void *client,
1046                                    const struct GNUNET_PeerIdentity *peer,
1047                                    enum GNUNET_ATS_PreferenceKind kind,
1048                                    float score)
1049 {
1050   struct GAS_SIMPLISTIC_Handle *s = solver;
1051   struct PreferenceClient *cur;
1052   struct PreferencePeer *p;
1053   int i;
1054   int clients;
1055   float p_rel_global;
1056   float *dest;
1057
1058
1059   GNUNET_assert (NULL != solver);
1060   GNUNET_assert (NULL != client);
1061   GNUNET_assert (NULL != peer);
1062
1063   LOG (GNUNET_ERROR_TYPE_DEBUG, "Client %p changes preference for peer `%s' %s %f\n",
1064                                 client,
1065                                 GNUNET_i2s (peer),
1066                                 GNUNET_ATS_print_preference_type (kind),
1067                                 score);
1068
1069   if (kind >= GNUNET_ATS_PreferenceCount)
1070   {
1071       GNUNET_break (0);
1072       return;
1073   }
1074
1075   /**
1076    * Idea:
1077    *
1078    * We have:
1079    * Set of clients c
1080    * Set of peers p_i in P
1081    * Set of preference kinds k
1082    * A preference value f_k_p_i with an unknown range
1083    *
1084    * We get:
1085    * A client specific relative preference f_p_i_rel [1..2] for all peers
1086    *
1087    * For every client c
1088    * {
1089    *   For every preference kind k:
1090    *   {
1091    *     We remember for the preference f_p_i for each peer p_i.
1092    *     We have a default preference value f_p_i = 0
1093    *     We have a sum of all preferences f_t = sum (f_p_i)
1094    *     So we can calculate a relative preference value fr_p_i:
1095    *
1096    *     f_k_p_i_rel = (f_t + f_p_i) / f_t
1097    *     f_k_p_i_rel = [1..2], default 1.0
1098    *    }
1099    *    f_p_i_rel = sum (f_k_p_i_rel) / #k
1100    * }
1101    *
1102    **/
1103
1104   /* Find preference client */
1105   for (cur = s->pc_head; NULL != cur; cur = cur->next)
1106   {
1107       if (client == cur->client)
1108         break;
1109   }
1110   /* Not found: create new preference client */
1111   if (NULL == cur)
1112   {
1113     cur = GNUNET_malloc (sizeof (struct PreferenceClient));
1114     cur->client = client;
1115     GNUNET_CONTAINER_DLL_insert (s->pc_head, s->pc_tail, cur);
1116   }
1117
1118   /* Find entry for peer */
1119   for (p = cur->p_head; NULL != p; p = p->next)
1120     if (0 == memcmp (&p->id, peer, sizeof (p->id)))
1121         break;
1122
1123   /* Not found: create new peer entry */
1124   if (NULL == p)
1125   {
1126       p = GNUNET_malloc (sizeof (struct PreferencePeer));
1127       p->id = (*peer);
1128       for (i = 0; i < GNUNET_ATS_PreferenceCount; i++)
1129       {
1130         /* Default value per peer absolut preference for a quality:
1131          * No value set, so absolute preference 0 */
1132         p->f[i] = 0.0;
1133         /* Default value per peer relative preference for a quality: 1.0 */
1134         p->f_rel[i] = DEFAULT_PREFERENCE;
1135       }
1136       GNUNET_CONTAINER_DLL_insert (cur->p_head, cur->p_tail, p);
1137   }
1138
1139   /* Update preference value according to type */
1140   switch (kind) {
1141     case GNUNET_ATS_PREFERENCE_BANDWIDTH:
1142     case GNUNET_ATS_PREFERENCE_LATENCY:
1143       p->f[kind] = (p->f[kind] + score) / 2;
1144       break;
1145     case GNUNET_ATS_PREFERENCE_END:
1146       break;
1147     default:
1148       break;
1149   }
1150
1151   /* Recalcalculate total preference for this quality kind over all peers*/
1152   cur->f_total[kind] = 0;
1153   for (p = cur->p_head; NULL != p; p = p->next)
1154     cur->f_total[kind] += p->f[kind];
1155
1156   LOG (GNUNET_ERROR_TYPE_DEBUG, "Client %p has total preference for %s of %.3f\n",
1157       cur->client,
1158       GNUNET_ATS_print_preference_type (kind),
1159       cur->f_total[kind]);
1160
1161   /* Recalcalculate relative preference for all peers */
1162   for (p = cur->p_head; NULL != p; p = p->next)
1163   {
1164     /* Calculate relative preference for specific kind */
1165     p->f_rel[kind] = (cur->f_total[kind] + p->f[kind]) / cur->f_total[kind];
1166     LOG (GNUNET_ERROR_TYPE_DEBUG, "Client %p: peer `%s' has relative preference for %s of %.3f\n",
1167         cur->client,
1168         GNUNET_i2s (&p->id),
1169         GNUNET_ATS_print_preference_type (kind),
1170         p->f_rel[kind]);
1171
1172     /* Calculate peer relative preference
1173      * Start with i = 1 to exclude terminator */
1174     p->f_rel_total = 0;
1175     for (i = 1; i < GNUNET_ATS_PreferenceCount; i ++)
1176     {
1177         p->f_rel_total += p->f_rel[i];
1178     }
1179     p->f_rel_total /=  (GNUNET_ATS_PreferenceCount - 1.0); /* -1 due to terminator */
1180     LOG (GNUNET_ERROR_TYPE_DEBUG, "Client %p: peer `%s' has total relative preference of %.3f\n",
1181         cur->client,
1182         GNUNET_i2s (&p->id),
1183         p->f_rel_total);
1184   }
1185
1186   /* Calculcate global total relative peer preference over all clients */
1187   p_rel_global = 0.0;
1188   clients = 0;
1189   for (cur = s->pc_head; NULL != cur; cur = cur->next)
1190   {
1191       for (p = cur->p_head; NULL != p; p = p->next)
1192           if (0 == memcmp (&p->id, peer, sizeof (p->id)))
1193               break;
1194       if (NULL != p)
1195       {
1196           clients++;
1197           p_rel_global += p->f_rel_total;
1198       }
1199   }
1200   p_rel_global /= clients;
1201   LOG (GNUNET_ERROR_TYPE_DEBUG, "Global preference value for peer `%s': %.3f\n",
1202       GNUNET_i2s (peer), p_rel_global);
1203
1204   /* Update global map */
1205   if (NULL != (dest = GNUNET_CONTAINER_multihashmap_get(s->prefs, &peer->hashPubKey)))
1206       (*dest) = p_rel_global;
1207   else
1208   {
1209       dest = GNUNET_malloc (sizeof (float));
1210       (*dest) = p_rel_global;
1211       GNUNET_CONTAINER_multihashmap_put(s->prefs,
1212           &peer->hashPubKey,
1213           dest,
1214           GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
1215   }
1216
1217
1218 }
1219
1220 /* end of gnunet-service-ats_addresses_simplistic.c */