src/ats/gnunet-service-ats-solver_proportional.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-solver_proportional.c
  23  * @brief ATS proportional solver
  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-proportional",__VA_ARGS__)
  33
  34 /**
  35  *
  36  * NOTE: Do not change this documentation. This documentation is based
  37  * on gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
  38  * use build_txt.sh to generate plaintext output
  39  *
  40  * ATS addresses : simplistic solver
  41  *
  42  *    The simplistic solver ("simplistic") distributes the available
  43  *    bandwidth fair over all the addresses influenced by the
  44  *    preference values. For each available network type an in- and
  45  *    outbound quota is configured and the bandwidth available in
  46  *    these networks is distributed over the addresses.  The solver
  47  *    first assigns every addresses the minimum amount of bandwidth
  48  *    GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT and then distributes the
  49  *    remaining bandwidth available according to the preference
  50  *    values. For each peer only a single address gets bandwidth
  51  *    assigned and only one address marked as active.  The most
  52  *    important functionality for the solver is implemented in: *
  53  *    find_address_it is an hashmap iterator returning the prefered
  54  *    address for an peer * update_quota_per_network distributes
  55  *    available bandwidth for a network over active addresses
  56  *
  57  *    Changes to addresses automatically have an impact on the the
  58  *    bandwidth assigned to other addresses in the same network since
  59  *    the solver distributes the remaining bandwidth over the
  60  *    addresses in the network.  When changes to the addresses occur,
  61  *    the solver first performs the changes, like adding or deleting
  62  *    addresses, and then updates bandwidth assignment for the
  63  *    affected network. Bandwidth assignment is only recalculated on
  64  *    demand when an address is requested by a client for a peer or
  65  *    when the addresses available have changed or an address changed
  66  *    the network it is located in. When the bandwidth assignment has
  67  *    changed the callback is called with the new bandwidth
  68  *    assignments. The bandwidth distribution for a network is
  69  *    recalculated due to: * address suggestion requests * address
  70  *    deletions * address switching networks during address update *
  71  *    preference changes
  72  *
  73  *     3.1 Data structures used
  74  *
  75  *    For each ATS network (e.g. WAN, LAN, loopback) a struct Network
  76  *    is used to specify network related information as total adresses
  77  *    and active addresses in this network and the configured in- and
  78  *    outbound quota. Each network also contains a list of addresses
  79  *    added to the solver located in this network. The simplistic
  80  *    solver uses the addresses' solver_information field to store the
  81  *    simplistic network it belongs to for each address.
  82  *
  83  *     3.2 Initializing
  84  *
  85  *    When the simplistic solver is initialized the solver creates a
  86  *    new solver handle and initializes the network structures with
  87  *    the quotas passed from addresses and returns the handle solver.
  88  *
  89  *     3.3 Adding an address
  90  *
  91  *    When a new address is added to the solver using s_add, a lookup
  92  *    for the network for this address is done and the address is
  93  *    enqueued in in the linked list of the network.
  94  *
  95  *     3.4 Updating an address
  96  *
  97  *    The main purpose of address updates is to update the ATS
  98  *    information for addresse selection. Important for the simplistic
  99  *    solver is when an address switches network it is located
 100  *    in. This is common because addresses added by transport's
 101  *    validation mechanism are commonly located in
 102  *    GNUNET_ATS_NET_UNSPECIFIED. Addresses in validation are located
 103  *    in this network type and only if a connection is successful on
 104  *    return of payload data transport switches to the real network
 105  *    the address is located in.  When an address changes networks it
 106  *    is first of all removed from the old network using the solver
 107  *    API function GAS_simplistic_address_delete and the network in
 108  *    the address struct is updated. A lookup for the respective new
 109  *    simplistic network is done and stored in the addresse's
 110  *    solver_information field. Next the address is re-added to the
 111  *    solver using the solver API function
 112  *    GAS_simplistic_address_add. If the address was marked as in
 113  *    active, the solver checks if bandwidth is available in the
 114  *    network and if yes sets the address to active and updates the
 115  *    bandwidth distribution in this network. If no bandwidth is
 116  *    available it sets the bandwidth for this address to 0 and tries
 117  *    to suggest an alternative address. If an alternative address was
 118  *    found, addresses' callback is called for this address.
 119  *
 120  *     3.5 Deleting an address
 121  *
 122  *    When an address is removed from the solver, it removes the
 123  *    respective address from the network and if the address was
 124  *    marked as active, it updates the bandwidth distribution for this
 125  *    network.
 126  *
 127  *     3.6 Requesting addresses
 128  *
 129  *    When an address is requested for a peer the solver performs a
 130  *    lookup for the peer entry in addresses address hashmap and
 131  *    selects the best address.  The selection of the most suitable
 132  *    address is done in the find_address_it hashmap iterator
 133  *    described in detail in section 3.7. If no address is returned,
 134  *    no address can be suggested at the moment. If the address
 135  *    returned is marked as active, the solver can return this
 136  *    address. If the address is not marked as active, the solver
 137  *    checks if another address belongign to this peer is marked as
 138  *    active and marks the address as inactive, updates the bandwidth
 139  *    for this address to 0, call the bandwidth changed callback for
 140  *    this address due to the change and updates quota assignment for
 141  *    the addresse's network. the now in-active address is belonging
 142  *    to. The solver marks the new address as active and updates the
 143  *    bandwidth assignment for this network.
 144  *
 145  *     3.7 Choosing addresses
 146  *
 147  *    Choosing the best possible address for suggestion is done by
 148  *    iterating over all addresses of a peer stored in addresses'
 149  *    hashmap and using the hashmap iterator find_address_it to select
 150  *    the best available address.  Several checks are done when an
 151  *    address is selected. First if this address is currently blocked
 152  *    by addresses from being suggested. An address is blocked for the
 153  *    duration of ATS_BLOCKING_DELTA when it is suggested to
 154  *    transport. Next it is checked if at least
 155  *    GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT bytes bandwidth is available
 156  *    in the addresse's network, because suggesting an address without
 157  *    bandwidth does not make sense. This also ensures that all active
 158  *    addresses in this network get at least the minimum amount of
 159  *    bandwidth assigned. In the next step the solver ensures that for
 160  *    tcp connections inbound connections are prefered over outbound
 161  *    connections. In the next stet the solver ensures that
 162  *    connections are prefered in the following order: * connections
 163  *    are already established and have bandwidth assigned *
 164  *    connections with a shorter distance * connectes have a shorter
 165  *    latency
 166  *
 167  *     3.8 Changing preferences
 168  *
 169  *     3.9 Shutdown
 170  *
 171  *    During shutdown all network entries and aging processes are
 172  *    destroyed and freed.
 173  *
 174  *
 175  * OLD DOCUMENTATION
 176  *
 177  * This solver assigns in and outbound bandwidth equally for all
 178  * addresses in specific network type (WAN, LAN) based on configured
 179  * in and outbound quota for this network.
 180  *
 181  * The solver is notified by addresses about changes to the addresses
 182  * and recalculates the bandwith assigned if required. The solver
 183  * notifies addresses by calling the GAS_bandwidth_changed_cb
 184  * callback.
 185  *
 186  * - Initialization
 187  *
 188  *
 189  *
 190  *
 191  * For each peer only a single is selected and marked as "active" in the address
 192  * struct.
 193  *
 194  * E.g.:
 195  *
 196  * You have the networks WAN and LAN and quotas
 197  * WAN_TOTAL_IN, WAN_TOTAL_OUT
 198  * LAN_TOTAL_IN, LAN_TOTAL_OUT
 199  *
 200  * If you have x addresses in the network segment LAN, the quotas are
 201  * QUOTA_PER_ADDRESS = LAN_TOTAL_OUT / x
 202  *
 203  * Quotas are automatically recalculated and reported back when addresses are
 204  * - requested
 205  *
 206  */
 207
 208 #define PREF_AGING_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
 209 #define PREF_AGING_FACTOR 0.95
 210
 211 #define DEFAULT_REL_PREFERENCE 1.0
 212 #define DEFAULT_ABS_PREFERENCE 0.0
 213 #define MIN_UPDATE_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
 214
 215
 216 /**
 217  * A handle for the proportional solver
 218  */
 219 struct GAS_PROPORTIONAL_Handle
 220 {
 221   /**
 222    * Statistics handle
 223    */
 224   struct GNUNET_STATISTICS_Handle *stats;
 225
 226   /**
 227    * Hashmap containing all valid addresses
 228    */
 229   const struct GNUNET_CONTAINER_MultiHashMap *addresses;
 230
 231   /**
 232    * Bandwidth changed callback
 233    */
 234   GAS_bandwidth_changed_cb bw_changed;
 235
 236   /**
 237    * Bandwidth changed callback cls
 238    */
 239   void *bw_changed_cls;
 240
 241   /**
 242    * ATS function to get preferences
 243    */
 244   GAS_get_preferences get_preferences;
 245
 246   /**
 247    * Closure for ATS function to get preferences
 248    */
 249   void *get_preferences_cls;
 250
 251   /**
 252    * ATS function to get properties
 253    */
 254   GAS_get_properties get_properties;
 255
 256   /**
 257    * Closure for ATS function to get properties
 258    */
 259   void *get_properties_cls;
 260
 261   /**
 262    * Bulk lock
 263    */
 264   int bulk_lock;
 265
 266   /**
 267    * Number of changes while solver was locked
 268    */
 269   int bulk_requests;
 270
 271
 272   /**
 273    * Total number of addresses for solver
 274    */
 275   unsigned int total_addresses;
 276
 277   /**
 278    * Number of active addresses for solver
 279    */
 280   unsigned int active_addresses;
 281
 282   /**
 283    * Networks array
 284    */
 285   struct Network *network_entries;
 286
 287   /**
 288    * Number of networks
 289    */
 290   unsigned int networks;
 291
 292 };
 293
 294
 295 /**
 296  * Representation of a network
 297  */
 298 struct Network
 299 {
 300   /**
 301    * ATS network type
 302    */
 303   unsigned int type;
 304
 305   /**
 306    * Network description
 307    */
 308   char *desc;
 309
 310   /**
 311    * Total inbound quota
 312    *
 313    */
 314   unsigned long long total_quota_in;
 315
 316   /**
 317    * Total outbound quota
 318    *
 319    */
 320   unsigned long long total_quota_out;
 321
 322   /**
 323    * Number of active addresses for this network
 324    */
 325   unsigned int active_addresses;
 326
 327   /**
 328    * Number of total addresses for this network
 329    */
 330   unsigned int total_addresses;
 331
 332   /**
 333    * String for statistics total addresses
 334    */
 335   char *stat_total;
 336
 337   /**
 338    * String for statistics active addresses
 339    */
 340   char *stat_active;
 341
 342   struct AddressWrapper *head;
 343   struct AddressWrapper *tail;
 344 };
 345
 346
 347 /**
 348  * Wrapper for addresses to store them in network's linked list
 349  */
 350 struct AddressWrapper
 351 {
 352   /**
 353    * Next in DLL
 354    */
 355   struct AddressWrapper *next;
 356
 357   /**
 358    * Previous in DLL
 359    */
 360   struct AddressWrapper *prev;
 361
 362   /**
 363    * The address
 364    */
 365   struct ATS_Address *addr;
 366 };
 367
 368
 369
 370 /**
 371  *  Important solver functions
 372  *  ---------------------------
 373  */
 374
 375 /**
 376  * Test if bandwidth is available in this network to add an additional address
 377  *
 378  * @param net the network type to update
 379  * @return GNUNET_YES or GNUNET_NO
 380  */
 381 static int
 382 is_bandwidth_available_in_network (struct Network *net)
 383 {
 384         GNUNET_assert (NULL != net);
 385   unsigned int na = net->active_addresses + 1;
 386   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
 387   if (((net->total_quota_in / na) > min_bw) &&
 388       ((net->total_quota_out / na) > min_bw))
 389   {
 390     LOG (GNUNET_ERROR_TYPE_DEBUG,
 391          "Enough bandwidth available for %u active addresses in network `%s'\n",
 392          na,
 393          net->desc);
 394
 395     return GNUNET_YES;
 396   }
 397     LOG (GNUNET_ERROR_TYPE_DEBUG,
 398          "Not enough bandwidth available for %u active addresses in network `%s'\n",
 399          na,
 400          net->desc);
 401   return GNUNET_NO;
 402 }
 403
 404
 405 /**
 406  * Update bandwidth assigned to peers in this network
 407  *
 408  * @param s the solver handle
 409  * @param net the network type to update
 410  * @param address_except address excluded from notification, since we suggest
 411  * this address
 412  */
 413 static void
 414 distribute_bandwidth_in_network (struct GAS_PROPORTIONAL_Handle *s,
 415                           struct Network *net,
 416                           struct ATS_Address *address_except)
 417 {
 418   unsigned long long remaining_quota_in = 0;
 419   unsigned long long quota_out_used = 0;
 420
 421   unsigned long long remaining_quota_out = 0;
 422   unsigned long long quota_in_used = 0;
 423   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
 424   double peer_prefs;
 425   double total_prefs; /* Important: has to be double not float due to precision */
 426   double cur_pref; /* Important: has to be double not float due to precision */
 427   const double *t = NULL; /* Important: has to be double not float due to precision */
 428   int c;
 429
 430   unsigned long long assigned_quota_in = 0;
 431   unsigned long long assigned_quota_out = 0;
 432   struct AddressWrapper *cur;
 433
 434
 435         if (GNUNET_YES == s->bulk_lock)
 436         {
 437                 s->bulk_requests++;
 438                 return;
 439         }
 440
 441   LOG (GNUNET_ERROR_TYPE_DEBUG,
 442               "Recalculate quota for network type `%s' for %u addresses (in/out): %llu/%llu \n",
 443               net->desc, net->active_addresses, net->total_quota_in, net->total_quota_in);
 444
 445   if (net->active_addresses == 0)
 446     return; /* no addresses to update */
 447
 448   /* Idea
 449    * Assign every peer in network minimum Bandwidth
 450    * Distribute bandwidth left according to preference
 451    */
 452
 453   if ((net->active_addresses * min_bw) > net->total_quota_in)
 454   {
 455     GNUNET_break (0);
 456     return;
 457   }
 458   if ((net->active_addresses * min_bw) > net->total_quota_out)
 459   {
 460     GNUNET_break (0);
 461     return;
 462   }
 463
 464   remaining_quota_in = net->total_quota_in - (net->active_addresses * min_bw);
 465   remaining_quota_out = net->total_quota_out - (net->active_addresses * min_bw);
 466   LOG (GNUNET_ERROR_TYPE_DEBUG, "Remaining bandwidth : (in/out): %llu/%llu \n",
 467               remaining_quota_in, remaining_quota_out);
 468   total_prefs = 0.0;
 469   for (cur = net->head; NULL != cur; cur = cur->next)
 470   {
 471       if (GNUNET_YES == cur->addr->active)
 472       {
 473         GNUNET_assert (NULL != (t = s->get_preferences (s->get_preferences_cls, &cur->addr->peer)));
 474
 475                                 peer_prefs = 0.0;
 476                                 for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
 477                                 {
 478                                         if (c != GNUNET_ATS_PREFERENCE_END)
 479                                         {
 480                                                 //fprintf (stderr, "VALUE[%u] %s %.3f \n", c, GNUNET_i2s (&cur->addr->peer), t[c]);
 481                                                 peer_prefs += t[c];
 482                                         }
 483                                 }
 484                                 total_prefs += (peer_prefs / (GNUNET_ATS_PreferenceCount -1));
 485       }
 486   }
 487   for (cur = net->head; NULL != cur; cur = cur->next)
 488   {
 489      if (GNUNET_YES == cur->addr->active)
 490      {
 491        cur_pref = 0.0;
 492        GNUNET_assert (NULL != (t = s->get_preferences (s->get_preferences_cls, &cur->addr->peer)));
 493
 494                          for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
 495                          {
 496                                  if (c != GNUNET_ATS_PREFERENCE_END)
 497                                          cur_pref += t[c];
 498                          }
 499                          cur_pref /= 2;
 500
 501        assigned_quota_in = min_bw + ((cur_pref / total_prefs) * remaining_quota_in);
 502        assigned_quota_out = min_bw + ((cur_pref / total_prefs) * remaining_quota_out);
 503
 504        LOG (GNUNET_ERROR_TYPE_DEBUG,
 505                    "New quota for peer `%s' with preference (cur/total) %.3f/%.3f (in/out): %llu / %llu\n",
 506                    GNUNET_i2s (&cur->addr->peer),
 507                    cur_pref, total_prefs,
 508                    assigned_quota_in, assigned_quota_out);
 509      }
 510      else
 511      {
 512        assigned_quota_in = 0;
 513        assigned_quota_out = 0;
 514      }
 515
 516      quota_in_used += assigned_quota_in;
 517      quota_out_used += assigned_quota_out;
 518      /* Prevent overflow due to rounding errors */
 519      if (assigned_quota_in > UINT32_MAX)
 520        assigned_quota_in = UINT32_MAX;
 521      if (assigned_quota_out > UINT32_MAX)
 522        assigned_quota_out = UINT32_MAX;
 523
 524      /* Compare to current bandwidth assigned */
 525      if ((assigned_quota_in != ntohl(cur->addr->assigned_bw_in.value__)) ||
 526          (assigned_quota_out != ntohl(cur->addr->assigned_bw_out.value__)))
 527      {
 528        cur->addr->assigned_bw_in.value__ = htonl (assigned_quota_in);
 529        cur->addr->assigned_bw_out.value__ = htonl (assigned_quota_out);
 530        /* Notify on change */
 531        if ((GNUNET_YES == cur->addr->active) && (cur->addr != address_except))
 532          s->bw_changed (s->bw_changed_cls, cur->addr);
 533      }
 534
 535   }
 536   LOG (GNUNET_ERROR_TYPE_DEBUG,
 537                           "Total bandwidth assigned is (in/out): %llu /%llu\n",
 538                           quota_in_used,
 539                           quota_out_used);
 540   if (quota_out_used > net->total_quota_out + 1) /* +1 is required due to rounding errors */
 541   {
 542       LOG (GNUNET_ERROR_TYPE_ERROR,
 543                             "Total outbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
 544                             net->active_addresses,
 545                             quota_out_used,
 546                             net->total_quota_out);
 547   }
 548   if (quota_in_used > net->total_quota_in + 1) /* +1 is required due to rounding errors */
 549   {
 550       LOG (GNUNET_ERROR_TYPE_ERROR,
 551                             "Total inbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
 552                             net->active_addresses,
 553                             quota_in_used,
 554                             net->total_quota_in);
 555   }
 556 }
 557
 558
 559 /**
 560  * Extract an ATS performance info from an address
 561  *
 562  * @param address the address
 563  * @param type the type to extract in HBO
 564  * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
 565  */
 566 static int
 567 get_performance_info (struct ATS_Address *address, uint32_t type);
 568
 569
 570
 571 struct FindBestAddressCtx
 572 {
 573         struct GAS_PROPORTIONAL_Handle *s;
 574         struct ATS_Address *best;
 575 };
 576
 577
 578 static int
 579 find_property_index (uint32_t type)
 580 {
 581         int existing_types[] = GNUNET_ATS_QualityProperties;
 582         int c;
 583         for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
 584                 if (existing_types[c] == type)
 585                         return c;
 586         return GNUNET_SYSERR;
 587 }
 588
 589 /**
 590  * Find a "good" address to use for a peer by iterating over the addresses for this peer.
 591  * If we already have an existing address, we stick to it.
 592  * Otherwise, we pick by lowest distance and then by lowest latency.
 593  *
 594  * @param cls the 'struct ATS_Address**' where we store the result
 595  * @param key unused
 596  * @param value another 'struct ATS_Address*' to consider using
 597  * @return GNUNET_OK (continue to iterate)
 598  */
 599 static int
 600 find_best_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
 601 {
 602         struct FindBestAddressCtx *fba_ctx = (struct FindBestAddressCtx *) cls;
 603   struct ATS_Address *current = (struct ATS_Address *) value;
 604   struct GNUNET_TIME_Absolute now;
 605   struct Network *net = (struct Network *) current->solver_information;
 606   const double *norm_prop_cur;
 607   const double *norm_prop_prev;
 608   int index;
 609
 610   now = GNUNET_TIME_absolute_get();
 611
 612   if (current->blocked_until.abs_value == GNUNET_TIME_absolute_max (now, current->blocked_until).abs_value)
 613   {
 614     /* This address is blocked for suggestion */
 615     LOG (GNUNET_ERROR_TYPE_DEBUG,
 616                 "Address %p blocked for suggestion for %llu ms \n",
 617                 current,
 618                 GNUNET_TIME_absolute_get_difference(now, current->blocked_until).rel_value);
 619     return GNUNET_OK;
 620   }
 621   if (GNUNET_NO == is_bandwidth_available_in_network (net))
 622     return GNUNET_OK; /* There's no bandwidth available in this network */
 623   if (NULL != fba_ctx->best)
 624   {
 625         GNUNET_assert (NULL != fba_ctx->best->plugin);
 626         GNUNET_assert (NULL != current->plugin);
 627     if (0 == strcmp (fba_ctx->best->plugin, current->plugin))
 628     {
 629       if ((0 != fba_ctx->best->addr_len) &&
 630           (0 == current->addr_len))
 631       {
 632         /* saved address was an outbound address, but we have an inbound address */
 633         fba_ctx->best = current;
 634         return GNUNET_OK;
 635       }
 636       if (0 == fba_ctx->best->addr_len)
 637       {
 638         /* saved address was an inbound address, so do not overwrite */
 639         return GNUNET_OK;
 640       }
 641     }
 642   }
 643   if (NULL == fba_ctx->best)
 644   {
 645         fba_ctx->best = current;
 646     return GNUNET_OK;
 647   }
 648   if ((ntohl (fba_ctx->best->assigned_bw_in.value__) == 0) &&
 649       (ntohl (current->assigned_bw_in.value__) > 0))
 650   {
 651     /* stick to existing connection */
 652         fba_ctx->best = current;
 653     return GNUNET_OK;
 654   }
 655
 656   norm_prop_cur = fba_ctx->s->get_properties (fba_ctx->s->get_properties_cls,
 657                 (const struct ATS_Address *) current);
 658   norm_prop_prev = fba_ctx->s->get_properties (fba_ctx->s->get_properties_cls,
 659                 (const struct ATS_Address *) fba_ctx->best);
 660 /*
 661   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "%s previous %.2f current %.2f\n",
 662                 "DISTANCE", norm_prop_cur[1], norm_prop_cur[1]);
 663 */
 664   index = find_property_index (GNUNET_ATS_QUALITY_NET_DISTANCE);
 665   if (GNUNET_SYSERR == index)
 666   {
 667         GNUNET_break (0);
 668         return GNUNET_OK;
 669   }
 670   if (norm_prop_cur[index] < norm_prop_prev[index])
 671   {
 672     /* user shorter distance */
 673     fba_ctx->best = current;
 674     return GNUNET_OK;
 675   }
 676 /*
 677   GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "%s previous %.2f current %.2f\n",
 678                 "DELAY", norm_prop_cur[1], norm_prop_cur[1]);
 679  */
 680   index = find_property_index (GNUNET_ATS_QUALITY_NET_DELAY);
 681   if (GNUNET_SYSERR == index)
 682   {
 683         GNUNET_break (0);
 684         return GNUNET_OK;
 685   }
 686   if (norm_prop_cur[index] < norm_prop_prev[index])
 687   {
 688     /* user shorter delay */
 689         fba_ctx->best = current;
 690     return GNUNET_OK;
 691   }
 692
 693   /* don't care */
 694   return GNUNET_OK;
 695 }
 696
 697 /**
 698  *  Helper functions
 699  *  ---------------------------
 700  */
 701
 702 /**
 703  * Update bandwidth assignment for all networks
 704  *
 705  * @param s the solver handle
 706  */
 707 static void
 708 distribute_bandwidth_in_all_networks (struct GAS_PROPORTIONAL_Handle *s)
 709 {
 710         int i;
 711
 712         for (i = 0; i < s->networks; i++)
 713                 distribute_bandwidth_in_network (s, &s->network_entries[i], NULL);
 714
 715 }
 716
 717
 718 /**
 719  * Lookup network struct by type
 720  *
 721  * @param s the solver handle
 722  * @param type the network type
 723  * @return the network struct
 724  */
 725 static struct Network *
 726 get_network (struct GAS_PROPORTIONAL_Handle *s, uint32_t type)
 727 {
 728   int c;
 729   for (c = 0 ; c < s->networks; c++)
 730   {
 731       if (s->network_entries[c].type == type)
 732         return &s->network_entries[c];
 733
 734   }
 735   return NULL;
 736 }
 737
 738
 739 /**
 740  * Hashmap Iterator to find current active address for peer
 741  *
 742  * @param cls last active address
 743  * @param key peer's key
 744  * @param value address to check
 745  * @return GNUNET_NO on double active address else GNUNET_YES;
 746  */
 747 static int
 748 get_active_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
 749 {
 750   struct ATS_Address * dest = (struct ATS_Address *) (*(struct ATS_Address **)cls);
 751   struct ATS_Address * aa = (struct ATS_Address *) value;
 752
 753   if (GNUNET_YES == aa->active)
 754   {
 755       if (dest != NULL)
 756       {
 757           /* should never happen */
 758           LOG (GNUNET_ERROR_TYPE_ERROR, "Multiple active addresses for peer `%s'\n", GNUNET_i2s (&aa->peer));
 759           GNUNET_break (0);
 760           return GNUNET_NO;
 761       }
 762       dest = aa;
 763   }
 764   return GNUNET_OK;
 765 }
 766
 767
 768 /**
 769  * Find current active address for peer
 770  *
 771  * @param solver the solver handle
 772  * @param addresses the address set
 773  * @param peer the peer
 774  * @return active address or NULL
 775  */
 776 static struct ATS_Address *
 777 get_active_address (void *solver,
 778                      struct GNUNET_CONTAINER_MultiHashMap * addresses,
 779                      const struct GNUNET_PeerIdentity *peer)
 780 {
 781   struct ATS_Address * dest = NULL;
 782
 783   GNUNET_CONTAINER_multihashmap_get_multiple(addresses,
 784        &peer->hashPubKey,
 785        &get_active_address_it, &dest);
 786   return dest;
 787 }
 788
 789
 790
 791 static void
 792 addresse_increment (struct GAS_PROPORTIONAL_Handle *s,
 793                                 struct Network *net,
 794                                 int total,
 795                                 int active)
 796 {
 797   if (GNUNET_YES == total)
 798   {
 799       s->total_addresses ++;
 800       net->total_addresses ++;
 801       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", 1, GNUNET_NO);
 802       GNUNET_STATISTICS_update (s->stats, net->stat_total, 1, GNUNET_NO);
 803   }
 804   if (GNUNET_YES == active)
 805   {
 806     net->active_addresses ++;
 807     s->active_addresses ++;
 808     GNUNET_STATISTICS_update (s->stats, "# ATS active addresses total", 1, GNUNET_NO);
 809     GNUNET_STATISTICS_update (s->stats, net->stat_active, 1, GNUNET_NO);
 810   }
 811
 812 }
 813
 814
 815 static int
 816 addresse_decrement (struct GAS_PROPORTIONAL_Handle *s,
 817                     struct Network *net,
 818                     int total,
 819                     int active)
 820 {
 821   int res = GNUNET_OK;
 822   if (GNUNET_YES == total)
 823   {
 824     if (s->total_addresses < 1)
 825     {
 826       GNUNET_break (0);
 827       res = GNUNET_SYSERR;
 828     }
 829     else
 830     {
 831       s->total_addresses --;
 832       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
 833     }
 834     if (net->total_addresses < 1)
 835     {
 836       GNUNET_break (0);
 837       res = GNUNET_SYSERR;
 838     }
 839     else
 840     {
 841       net->total_addresses --;
 842       GNUNET_STATISTICS_update (s->stats, net->stat_total, -1, GNUNET_NO);
 843     }
 844   }
 845
 846   if (GNUNET_YES == active)
 847   {
 848     if (net->active_addresses < 1)
 849     {
 850       GNUNET_break (0);
 851       res = GNUNET_SYSERR;
 852     }
 853     else
 854     {
 855       net->active_addresses --;
 856       GNUNET_STATISTICS_update (s->stats, net->stat_active, -1, GNUNET_NO);
 857     }
 858     if (s->active_addresses < 1)
 859     {
 860       GNUNET_break (0);
 861       res = GNUNET_SYSERR;
 862     }
 863     else
 864     {
 865       s->active_addresses --;
 866       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
 867     }
 868   }
 869   return res;
 870 }
 871
 872
 873 /**
 874  * Extract an ATS performance info from an address
 875  *
 876  * @param address the address
 877  * @param type the type to extract in HBO
 878  * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
 879  */
 880 static int
 881 get_performance_info (struct ATS_Address *address, uint32_t type)
 882 {
 883         int c1;
 884         GNUNET_assert (NULL != address);
 885
 886         if ((NULL == address->atsi) || (0 == address->atsi_count))
 887                         return GNUNET_ATS_VALUE_UNDEFINED;
 888
 889         for (c1 = 0; c1 < address->atsi_count; c1++)
 890         {
 891                         if (ntohl(address->atsi[c1].type) == type)
 892                                 return ntohl(address->atsi[c1].value);
 893         }
 894         return GNUNET_ATS_VALUE_UNDEFINED;
 895 }
 896
 897
 898 /**
 899  *  Solver API functions
 900  *  ---------------------------
 901  */
 902
 903 /**
 904  * Changes the preferences for a peer in the problem
 905  *
 906  * @param solver the solver handle
 907  * @param peer the peer to change the preference for
 908  * @param kind the kind to change the preference
 909  * @param pref_rel the normalized preference value for this kind over all clients
 910  */
 911 void
 912 GAS_proportional_address_change_preference (void *solver,
 913                                                                                         const struct GNUNET_PeerIdentity *peer,
 914                                                                                         enum GNUNET_ATS_PreferenceKind kind,
 915                                                                                         double pref_rel)
 916 {
 917   struct GAS_PROPORTIONAL_Handle *s = solver;
 918   GNUNET_assert (NULL != solver);
 919   GNUNET_assert (NULL != peer);
 920
 921         distribute_bandwidth_in_all_networks (s);
 922 }
 923
 924
 925 /**
 926  * Get the preferred address for a specific peer
 927  *
 928  * @param solver the solver handle
 929  * @param addresses the address hashmap containing all addresses
 930  * @param peer the identity of the peer
 931  */
 932 const struct ATS_Address *
 933 GAS_proportional_get_preferred_address (void *solver,
 934                                const struct GNUNET_PeerIdentity *peer)
 935 {
 936   struct GAS_PROPORTIONAL_Handle *s = solver;
 937   struct Network *net_prev;
 938   struct Network *net_cur;
 939   struct ATS_Address *prev;
 940   struct FindBestAddressCtx fba_ctx;
 941
 942   GNUNET_assert (s != NULL);
 943   GNUNET_assert (peer != NULL);
 944
 945   /* Get address with: stick to current address, lower distance, lower latency */
 946   fba_ctx.s = s;
 947   fba_ctx.best = NULL;
 948
 949   GNUNET_CONTAINER_multihashmap_get_multiple (s->addresses, &peer->hashPubKey,
 950                                               &find_best_address_it, &fba_ctx);
 951   if (NULL == fba_ctx.best)
 952   {
 953     LOG (GNUNET_ERROR_TYPE_DEBUG, "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
 954     return NULL;
 955   }
 956
 957   LOG (GNUNET_ERROR_TYPE_DEBUG, "Suggesting %s address %p for peer `%s'\n",
 958       (GNUNET_NO == fba_ctx.best->active) ? "inactive" : "active",
 959                 fba_ctx.best, GNUNET_i2s (peer));
 960   net_cur = (struct Network *) fba_ctx.best->solver_information;
 961   if (NULL == fba_ctx.best)
 962   {
 963     LOG (GNUNET_ERROR_TYPE_ERROR, "Trying to suggesting unknown address peer `%s'\n",
 964         GNUNET_i2s (peer));
 965     GNUNET_break (0);
 966     return NULL;
 967   }
 968   if (GNUNET_YES == fba_ctx.best->active)
 969   {
 970       /* This address was selected previously, so no need to update quotas */
 971       return fba_ctx.best;
 972   }
 973
 974   /* This address was not active, so we have to:
 975    *
 976    * - mark previous active address as not active
 977    * - update quota for previous address network
 978    * - update quota for this address network
 979    */
 980
 981   prev = get_active_address (s, (struct GNUNET_CONTAINER_MultiHashMap *) s->addresses, peer);
 982   if (NULL != prev)
 983   {
 984       net_prev = (struct Network *) prev->solver_information;
 985       prev->active = GNUNET_NO; /* No active any longer */
 986       prev->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0); /* no bw assigned */
 987       prev->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0); /* no bw assigned */
 988       s->bw_changed (s->bw_changed_cls, prev); /* notify about bw change, REQUIRED? */
 989       if (GNUNET_SYSERR == addresse_decrement (s, net_prev, GNUNET_NO, GNUNET_YES))
 990         GNUNET_break (0);
 991         distribute_bandwidth_in_network (s, net_prev, NULL);
 992   }
 993
 994   if (GNUNET_NO == (is_bandwidth_available_in_network (fba_ctx.best->solver_information)))
 995   {
 996     GNUNET_break (0); /* This should never happen*/
 997     return NULL;
 998   }
 999
1000   fba_ctx.best->active = GNUNET_YES;
1001   addresse_increment(s, net_cur, GNUNET_NO, GNUNET_YES);
1002   distribute_bandwidth_in_network (s, net_cur, fba_ctx.best);
1003   return fba_ctx.best;
1004 }
1005
1006
1007 /**
1008  * Stop notifying about address and bandwidth changes for this peer
1009  *
1010  * @param solver the solver handle
1011  * @param addresses address hashmap
1012  * @param peer the peer
1013  */
1014 void
1015 GAS_proportional_stop_get_preferred_address (void *solver,
1016                                      const struct GNUNET_PeerIdentity *peer)
1017 {
1018         return;
1019 }
1020
1021
1022 /**
1023  * Remove an address from the solver
1024  *
1025  * @param solver the solver handle
1026  * @param addresses the address hashmap containing all addresses
1027  * @param address the address to remove
1028  * @param session_only delete only session not whole address
1029  */
1030 void
1031 GAS_proportional_address_delete (void *solver,
1032                                                                                                                  struct ATS_Address *address,
1033                                                                                                                  int session_only)
1034 {
1035   struct GAS_PROPORTIONAL_Handle *s = solver;
1036   struct Network *net;
1037   struct AddressWrapper *aw;
1038
1039   /* Remove an adress completely, we have to:
1040    * - Remove from specific network
1041    * - Decrease number of total addresses
1042    * - If active:
1043    *   - decrease number of active addreses
1044    *   - update quotas
1045    */
1046
1047   net = (struct Network *) address->solver_information;
1048
1049   if (GNUNET_NO == session_only)
1050   {
1051     LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s address %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
1052         (GNUNET_NO == address->active) ? "inactive" : "active",
1053         address, GNUNET_i2s (&address->peer),
1054         net->desc, net->total_addresses, net->active_addresses);
1055
1056     /* Remove address */
1057     addresse_decrement (s, net, GNUNET_YES, GNUNET_NO);
1058     for (aw = net->head; NULL != aw; aw = aw->next)
1059     {
1060         if (aw->addr == address)
1061           break;
1062     }
1063     if (NULL == aw )
1064     {
1065         GNUNET_break (0);
1066         return;
1067     }
1068     GNUNET_CONTAINER_DLL_remove (net->head, net->tail, aw);
1069     GNUNET_free (aw);
1070   }
1071   else
1072   {
1073       /* Remove session only: remove if active and update */
1074       LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s session %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
1075           (GNUNET_NO == address->active) ? "inactive" : "active",
1076           address, GNUNET_i2s (&address->peer),
1077           net->desc, net->total_addresses, net->active_addresses);
1078   }
1079
1080   if (GNUNET_YES == address->active)
1081   {
1082       /* Address was active, remove from network and update quotas*/
1083       address->active = GNUNET_NO;
1084       if (GNUNET_SYSERR == addresse_decrement (s, net, GNUNET_NO, GNUNET_YES))
1085         GNUNET_break (0);
1086       distribute_bandwidth_in_network (s, net, NULL);
1087   }
1088   LOG (GNUNET_ERROR_TYPE_DEBUG, "After deleting address now total %u and active %u addresses in network `%s'\n",
1089       net->total_addresses,
1090       net->active_addresses,
1091       net->desc);
1092
1093 }
1094
1095
1096 /**
1097  * Start a bulk operation
1098  *
1099  * @param solver the solver
1100  */
1101 void
1102 GAS_proportional_bulk_start (void *solver)
1103 {
1104   LOG (GNUNET_ERROR_TYPE_DEBUG, "Locking solver for bulk operation ...\n");
1105   struct GAS_PROPORTIONAL_Handle *s = (struct GAS_PROPORTIONAL_Handle *) solver;
1106
1107   GNUNET_assert (NULL != solver);
1108   s->bulk_lock ++;
1109 }
1110
1111 /**
1112  * Bulk operation done
1113  */
1114 void
1115 GAS_proportional_bulk_stop (void *solver)
1116 {
1117         LOG (GNUNET_ERROR_TYPE_DEBUG, "Unlocking solver from bulk operation ...\n");
1118
1119   struct GAS_PROPORTIONAL_Handle *s = (struct GAS_PROPORTIONAL_Handle *) solver;
1120   GNUNET_assert (NULL != solver);
1121
1122   if (s->bulk_lock < 1)
1123   {
1124         GNUNET_break (0);
1125         return;
1126   }
1127   s->bulk_lock --;
1128   if ((0 == s->bulk_lock) && (0 < s->bulk_requests))
1129   {
1130         LOG (GNUNET_ERROR_TYPE_DEBUG, "No lock pending, recalculating\n");
1131         distribute_bandwidth_in_all_networks (s);
1132         s->bulk_requests = 0;
1133   }
1134 }
1135
1136
1137 /**
1138  * Add a new single address to a network
1139  *
1140  * @param solver the solver Handle
1141  * @param address the address to add
1142  * @param network network type of this address
1143  */
1144 void
1145 GAS_proportional_address_add (void *solver,
1146                                                                                                                         struct ATS_Address *address,
1147                                                                                                                         uint32_t network);
1148
1149 /**
1150  * Updates a single address in the solver and checks previous values
1151  *
1152  * @param solver the solver Handle
1153  * @param addresses the address hashmap containing all addresses
1154  * @param address the update address
1155  * @param session the previous session
1156  * @param in_use the previous address in use state
1157  * @param prev_ats previous ATS information
1158  * @param prev_atsi_count the previous atsi count
1159  */
1160 void
1161 GAS_proportional_address_update (void *solver,
1162                               struct ATS_Address *address,
1163                               uint32_t session,
1164                               int in_use,
1165                               const struct GNUNET_ATS_Information *prev_ats,
1166                               uint32_t prev_atsi_count)
1167 {
1168   struct ATS_Address *new;
1169   struct GAS_PROPORTIONAL_Handle *s = (struct GAS_PROPORTIONAL_Handle *) solver;
1170   int i;
1171   uint32_t prev_value;
1172   uint32_t prev_type;
1173   uint32_t addr_net;
1174   int save_active = GNUNET_NO;
1175   struct Network *new_net = NULL;
1176
1177   /* Check updates to performance information */
1178   for (i = 0; i < prev_atsi_count; i++)
1179   {
1180     prev_type = ntohl (prev_ats[i].type);
1181     prev_value = ntohl (prev_ats[i].value);
1182     switch (prev_type)
1183     {
1184     case GNUNET_ATS_UTILIZATION_UP:
1185     case GNUNET_ATS_UTILIZATION_DOWN:
1186     case GNUNET_ATS_QUALITY_NET_DELAY:
1187     case GNUNET_ATS_QUALITY_NET_DISTANCE:
1188     case GNUNET_ATS_COST_WAN:
1189     case GNUNET_ATS_COST_LAN:
1190     case GNUNET_ATS_COST_WLAN:
1191         /* No actions required here*/
1192         break;
1193     case GNUNET_ATS_NETWORK_TYPE:
1194
1195       addr_net = get_performance_info (address, GNUNET_ATS_NETWORK_TYPE);
1196       if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
1197       {
1198         GNUNET_break (0);
1199         addr_net = GNUNET_ATS_NET_UNSPECIFIED;
1200       }
1201       if (addr_net != prev_value)
1202       {
1203         /* Network changed */
1204         LOG (GNUNET_ERROR_TYPE_DEBUG, "Network type changed, moving %s address from `%s' to `%s'\n",
1205             (GNUNET_YES == address->active) ? "active" : "inactive",
1206              GNUNET_ATS_print_network_type(prev_value),
1207              GNUNET_ATS_print_network_type(addr_net));
1208
1209         save_active = address->active;
1210         /* remove from old network */
1211         GAS_proportional_address_delete (solver, address, GNUNET_NO);
1212
1213         /* set new network type */
1214         new_net = get_network (solver, addr_net);
1215         if (NULL == new_net)
1216         {
1217           /* Address changed to invalid network... */
1218           LOG (GNUNET_ERROR_TYPE_ERROR, _("Cannot find network of type `%u' %s\n"),
1219                         addr_net, GNUNET_ATS_print_network_type (addr_net));
1220           address->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0);
1221           address->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0);
1222           s->bw_changed  (s->bw_changed_cls, address);
1223           return;
1224         }
1225         address->solver_information = new_net;
1226
1227         /* Add to new network and update*/
1228         GAS_proportional_address_add (solver, address, addr_net);
1229         if (GNUNET_YES == save_active)
1230         {
1231           /* check if bandwidth available in new network */
1232           if (GNUNET_YES == (is_bandwidth_available_in_network (new_net)))
1233           {
1234               /* Suggest updated address */
1235               address->active = GNUNET_YES;
1236               addresse_increment (s, new_net, GNUNET_NO, GNUNET_YES);
1237               distribute_bandwidth_in_network (solver, new_net, NULL);
1238           }
1239           else
1240           {
1241             LOG (GNUNET_ERROR_TYPE_DEBUG, "Not enough bandwidth in new network, suggesting alternative address ..\n");
1242
1243             /* Set old address to zero bw */
1244             address->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0);
1245             address->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0);
1246             s->bw_changed  (s->bw_changed_cls, address);
1247
1248             /* Find new address to suggest since no bandwidth in network*/
1249             new = (struct ATS_Address *) GAS_proportional_get_preferred_address (s, &address->peer);
1250             if (NULL != new)
1251             {
1252                 /* Have an alternative address to suggest */
1253                 s->bw_changed  (s->bw_changed_cls, new);
1254             }
1255           }
1256         }
1257       }
1258       break;
1259     case GNUNET_ATS_ARRAY_TERMINATOR:
1260       break;
1261     default:
1262       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1263                   "Received unsupported ATS type %u\n", prev_type);
1264       GNUNET_break (0);
1265       break;
1266
1267     }
1268
1269   }
1270   if (address->session_id != session)
1271   {
1272       LOG (GNUNET_ERROR_TYPE_DEBUG,
1273                   "Session changed from %u to %u\n", session, address->session_id);
1274   }
1275   if (address->used != in_use)
1276   {
1277       LOG (GNUNET_ERROR_TYPE_DEBUG,
1278                   "Usage changed from %u to %u\n", in_use, address->used);
1279   }
1280
1281 }
1282
1283
1284 /**
1285  * Add a new single address to a network
1286  *
1287  * @param solver the solver Handle
1288  * @param addresses the address hashmap containing all addresses
1289  * @param address the address to add
1290  * @param network network type of this address
1291  */
1292 void
1293 GAS_proportional_address_add (void *solver,
1294                                                                                                                         struct ATS_Address *address,
1295                                                                                                                         uint32_t network)
1296 {
1297   struct GAS_PROPORTIONAL_Handle *s = solver;
1298   struct Network *net = NULL;
1299   struct AddressWrapper *aw = NULL;
1300   GNUNET_assert (NULL != s);
1301
1302   net = get_network (s, network);
1303   if (NULL == net)
1304   {
1305     GNUNET_break (0);
1306     return;
1307   }
1308
1309   aw = GNUNET_malloc (sizeof (struct AddressWrapper));
1310   aw->addr = address;
1311   GNUNET_CONTAINER_DLL_insert (net->head, net->tail, aw);
1312   addresse_increment (s, net, GNUNET_YES, GNUNET_NO);
1313   aw->addr->solver_information = net;
1314
1315   LOG (GNUNET_ERROR_TYPE_DEBUG, "After adding address now total %u and active %u addresses in network `%s'\n",
1316       net->total_addresses,
1317       net->active_addresses,
1318       net->desc);
1319 }
1320
1321
1322 /**
1323  * Init the proportional problem solver
1324  *
1325  * Quotas:
1326  * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
1327  * out_quota[i] contains outbound quota for network type i
1328  * in_quota[i] contains inbound quota for network type i
1329  *
1330  * Example
1331  * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
1332  * network[2]   == GNUNET_ATS_NET_LAN
1333  * out_quota[2] == 65353
1334  * in_quota[2]  == 65353
1335  *
1336  * @param cfg configuration handle
1337  * @param stats the GNUNET_STATISTICS handle
1338  * @param addresses hashmap containing all addresses
1339  * @param network array of GNUNET_ATS_NetworkType with length dest_length
1340  * @param out_quota array of outbound quotas
1341  * @param in_quota array of outbound quota
1342  * @param dest_length array length for quota arrays
1343  * @param bw_changed_cb callback for changed bandwidth amounts
1344  * @param bw_changed_cb_cls cls for callback
1345  * @param get_preference callback to get relative preferences for a peer
1346  * @param get_preference_cls cls for callback to get relative preferences
1347  * @return handle for the solver on success, NULL on fail
1348  */
1349 void *
1350 GAS_proportional_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1351                        const struct GNUNET_STATISTICS_Handle *stats,
1352                        const struct GNUNET_CONTAINER_MultiHashMap *addresses,
1353                        int *network,
1354                        unsigned long long *out_quota,
1355                        unsigned long long *in_quota,
1356                        int dest_length,
1357                        GAS_bandwidth_changed_cb bw_changed_cb,
1358                        void *bw_changed_cb_cls,
1359                        GAS_get_preferences get_preference,
1360                        void *get_preference_cls,
1361                        GAS_get_properties get_properties,
1362                        void *get_properties_cls)
1363 {
1364   int c;
1365   struct GAS_PROPORTIONAL_Handle *s = GNUNET_malloc (sizeof (struct GAS_PROPORTIONAL_Handle));
1366   struct Network * cur;
1367   char * net_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1368
1369   GNUNET_assert (NULL != cfg);
1370   GNUNET_assert (NULL != stats);
1371   GNUNET_assert (NULL != network);
1372   GNUNET_assert (NULL != bw_changed_cb);
1373   GNUNET_assert (NULL != get_preference);
1374   GNUNET_assert (NULL != get_properties);
1375
1376   s->stats = (struct GNUNET_STATISTICS_Handle *) stats;
1377   s->bw_changed = bw_changed_cb;
1378   s->bw_changed_cls = bw_changed_cb_cls;
1379   s->get_preferences = get_preference;
1380   s->get_preferences_cls = get_preference_cls;
1381   s->get_properties = get_properties;
1382   s->get_properties_cls = get_properties_cls;
1383   s->networks = dest_length;
1384   s->network_entries = GNUNET_malloc (dest_length * sizeof (struct Network));
1385   s->active_addresses = 0;
1386   s->total_addresses = 0;
1387   s->bulk_lock = GNUNET_NO;
1388   s->addresses = addresses;
1389
1390   for (c = 0; c < dest_length; c++)
1391   {
1392       cur = &s->network_entries[c];
1393       cur->total_addresses = 0;
1394       cur->active_addresses = 0;
1395       cur->type = network[c];
1396       cur->total_quota_in = in_quota[c];
1397       cur->total_quota_out = out_quota[c];
1398       cur->desc = net_str[c];
1399       GNUNET_asprintf (&cur->stat_total, "# ATS addresses %s total", cur->desc);
1400       GNUNET_asprintf (&cur->stat_active, "# ATS active addresses %s total", cur->desc);
1401   }
1402   return s;
1403 }
1404
1405
1406 /**
1407  * Shutdown the proportional problem solver
1408  *
1409  * @param solver the respective handle to shutdown
1410  */
1411 void
1412 GAS_proportional_done (void *solver)
1413 {
1414   struct GAS_PROPORTIONAL_Handle *s = solver;
1415   struct AddressWrapper *cur;
1416   struct AddressWrapper *next;
1417   int c;
1418   GNUNET_assert (s != NULL);
1419
1420   for (c = 0; c < s->networks; c++)
1421   {
1422       if (s->network_entries[c].total_addresses > 0)
1423       {
1424         LOG (GNUNET_ERROR_TYPE_ERROR,
1425                     "Had %u addresses for network `%s' not deleted during shutdown\n",
1426                     s->network_entries[c].total_addresses,
1427                     s->network_entries[c].desc);
1428         GNUNET_break (0);
1429       }
1430
1431       if (s->network_entries[c].active_addresses > 0)
1432       {
1433         LOG (GNUNET_ERROR_TYPE_ERROR,
1434                     "Had %u active addresses for network `%s' not deleted during shutdown\n",
1435                     s->network_entries[c].active_addresses,
1436                     s->network_entries[c].desc);
1437         GNUNET_break (0);
1438       }
1439
1440       next = s->network_entries[c].head;
1441       while (NULL != (cur = next))
1442       {
1443           next = cur->next;
1444           GNUNET_CONTAINER_DLL_remove (s->network_entries[c].head,
1445                                        s->network_entries[c].tail,
1446                                        cur);
1447           GNUNET_free (cur);
1448       }
1449       GNUNET_free (s->network_entries[c].stat_total);
1450       GNUNET_free (s->network_entries[c].stat_active);
1451   }
1452   if (s->total_addresses > 0)
1453   {
1454     LOG (GNUNET_ERROR_TYPE_ERROR,
1455                 "Had %u addresses not deleted during shutdown\n",
1456                 s->total_addresses);
1457     GNUNET_break (0);
1458   }
1459   if (s->active_addresses > 0)
1460   {
1461     LOG (GNUNET_ERROR_TYPE_ERROR,
1462                 "Had %u active addresses not deleted during shutdown\n",
1463                 s->active_addresses);
1464     GNUNET_break (0);
1465   }
1466   GNUNET_free (s->network_entries);
1467   GNUNET_free (s);
1468 }
1469
1470
1471 /* end of gnunet-service-ats-solver_proportional.c */