src/ats/gnunet-service-ats_addresses.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.c
  23  * @brief ats service address management
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #include "platform.h"
  28 #include "gnunet_ats_service.h"
  29 #include "gnunet-service-ats.h"
  30 #include "gnunet-service-ats_addresses.h"
  31 #include "gnunet-service-ats_performance.h"
  32 #include "gnunet-service-ats_scheduling.h"
  33 #include "gnunet-service-ats_reservations.h"
  34 #if HAVE_LIBGLPK
  35 #include "gnunet-service-ats_addresses_mlp.h"
  36 #endif
  37 #include "gnunet-service-ats_addresses_simplistic.h"
  38
  39 /**
  40  * NOTE: Do not change this documentation. This documentation is based on
  41  * gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
  42  * use build_txt.sh to generate plaintext output
  43  *
  44  *   1 ATS addresses : ATS address management
  45  *
  46  *    This ATS addresses ("addresses") component manages the addresses known to
  47  *    ATS service and suggests addresses to transport service when it is
  48  *    interested in address suggestion for a peer. ATS addresses also
  49  *    instantiates the bandwidth assignment mechanism (solver), notifies it
  50  *    about changes to addresses and forwards changes to bandwidth assignments
  51  *    to transport, depending if transport is interested in this change.
  52  *
  53  *     1.1 Input data
  54  *
  55  *       1.1.1 Addresses
  56  *
  57  *    Addresses are added by specifying peer ID, plugin, address, address length
  58  *    and session, if available. ATS information can be specified if available.
  59  *
  60  *       1.1.2 Networks
  61  *
  62  *    ATS specifies a fix set of networks an address can belong to. For each
  63  *    network an inbound and outbound quota will be specified. The available
  64  *    networks and addtional helper varaibles are defined in
  65  *    gnunet_ats_service.h. At the moment 5 networks are defined:
  66  *      * GNUNET_ATS_NET_UNSPECIFIED
  67  *      * GNUNET_ATS_NET_LOOPBACK
  68  *      * GNUNET_ATS_NET_LAN
  69  *      * GNUNET_ATS_NET_WAN
  70  *      * GNUNET_ATS_NET_WLAN
  71  *
  72  *    The total number of networks defined is stored in
  73  *    GNUNET_ATS_NetworkTypeCount GNUNET_ATS_NetworkType can be used array
  74  *    initializer for an int array, while GNUNET_ATS_NetworkType is an
  75  *    initializer for a char array containing a string description of all
  76  *    networks
  77  *
  78  *       1.1.3 Quotas
  79  *
  80  *    An inbound and outbound quota for each of the networks mentioned in 1.1.2
  81  *    is loaded from ats configuration during initialization. This quota defines
  82  *    to total amount of inbound and outbound traffic allowed for a specific
  83  *    network. The configuration values used are in section ats:
  84  *      * "NETWORK"_QUOTA_IN = <value>
  85  *      * "NETWORK"_QUOTA_IN = <value>
  86  *
  87  *    You can specify quotas by setting the <value> to a:
  88  *      * unrestricted: unlimited
  89  *      * number of bytes: e.g. 10240
  90  *      * fancy value: e.g. 64 Kib
  91  *
  92  *    unlimited is defined as GNUNET_ATS_MaxBandwidthString and equivalent to
  93  *    the value GNUNET_ATS_MaxBandwidth Important predefined values for quotas
  94  *    are:
  95  *      * GNUNET_ATS_DefaultBandwidth: 65536
  96  *      * GNUNET_ATS_MaxBandwidth: UINT32_MAX
  97  *      * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT: 1024
  98  *
  99  *    Details of loading quotas and default values will be described on
 100  *
 101  *       1.1.4 Preference values
 102  *
 103  *     1.2 Data structures used
 104  *
 105  *    Addresse uses struct ATS_Address for each address. The structs are stored
 106  *    in a linked list and provides a pointer void *solver_information for the
 107  *    solver to store address specific information. It provides the int values
 108  *    active which is set to GNUNET_YES if the address is select for transport
 109  *    use and used, representing that transport service is actively using this
 110  *    address. Address information are stored in peer, addr, addr_len, plugin.
 111  *
 112  *     1.3 Initialization
 113  *
 114  *    During initialization a hashmap to store addresses is created. The quotas
 115  *    for all networks defined for ATS are loaded from configuration. For each
 116  *    network first the logic will check if the string
 117  *    GNUNET_ATS_MaxBandwidthString is configured, if not it will try to convert
 118  *    the configured value as a fancy size and if this fails it will try to use
 119  *    it as a value_number. If no configuration value is found it will assign
 120  *    GNUNET_ATS_DefaultBandwidth. The most important step is to load the
 121  *    configured solver using configuration "[ats]:MODE". Current solvers are
 122  *    MODE_SIMPLISTIC, MODE_MLP. Interaction is done using a solver API
 123  *
 124  *     1.4 Solver API
 125  *
 126  *    Solver functions:
 127  *      * s_init: init the solver with required information
 128  *      * s_add: add a new address
 129  *      * s_update: update ATS values or session for an address
 130  *      * s_get: get prefered address for a peer
 131  *      * s_del: delete an address
 132  *      * s_pref: change preference value for a peer
 133  *      * s_done: shutdown solver
 134  *
 135  *    Callbacks: addresses provides a bandwidth_changed_cb callback to the
 136  *    solver which is called when bandwidth assigned to peer has changed
 137  *
 138  *     1.5 Shutdown
 139  *
 140  *    During shutdown all addresses are freed and the solver told to shutdown
 141  *
 142  *     1.6 Addresses and sessions
 143  *
 144  *    Addresses consist of the address itself and a numerical session. When a
 145  *    new address without a session is added it has no session, so it gets
 146  *    session 0 assigned. When an address with a session is added and an address
 147  *    object with session 0 is found, this object is updated with the session
 148  *    otherwise a new address object with this session assigned is created.
 149  *
 150  *       1.6.1 Terminology
 151  *
 152  *    Addresses a1,a2 with session s1, s2 are "exact" if:
 153  *    (a1 == a2)&&(s1 == s2)
 154  *    Addresses a1,a2 with session s1, s2 are "equivalent" if:
 155  *    (a1 == a2)&&((s1 == s2)||(s1 == 0)||(s2 == 0)
 156  *
 157  *     1.7 Address management
 158  *
 159  *    Transport service notifies ATS about changes to the addresses known to
 160  *    him.
 161  *
 162  *       1.7.1 Adding an address
 163  *
 164  *    When transport learns a new address it tells ATS and ATS is telling
 165  *    addresses about it using GAS_address_add. If not known to addresses it
 166  *    creates a new address object and calls solver's s_add. ATS information are
 167  *    deserialized and solver is notified about the session and ATS information
 168  *    using s_update.
 169  *
 170  *       1.7.2 Updating an address
 171  *
 172  *    Addresses does an lookup up for the existing address with the given
 173  *    session. If disassembles included ATS information and notifies the solver
 174  *    using s_update about the update.
 175  *
 176  *       1.7.3 Deleting an address
 177  *
 178  *    Addresses does an lookup for the exact address and session and if removes
 179  *    this address. If session != 0 the session is set to 0 and the address is
 180  *    kept. If session == 0, the addresses is removed.
 181  *
 182  *       1.7.4 Requesting an address suggestion
 183  *
 184  *    The address client issues a request address message to be notified about
 185  *    address suggestions for a specific peer. Addresses asks the solver with
 186  *    s_get. If no address is available, it will not send a response, otherwise
 187  *    it will respond with the choosen address.
 188  *
 189  *       1.7.5 Address suggestions
 190  *
 191  *    Addresses will notify the client automatically on any bandwidth_changed_cb
 192  *    by the solver if a address suggestion request is pending. If no address is
 193  *    available it will not respond at all If the client is not interested
 194  *    anymore, it has to cancel the address suggestion request.
 195  *
 196  *       1.7.6 Suggestions blocks and reset
 197  *
 198  *    After suggesting an address it is blocked for ATS_BLOCKING_DELTA sec. to
 199  *    prevent the client from being thrashed. If the client requires immediately
 200  *    it can reset this block using GAS_addresses_handle_backoff_reset.
 201  *
 202  *       1.7.7 Marking address in use
 203  *
 204  *    The client can notify addresses that it successfully uses an address and
 205  *    wants this address to be kept by calling GSA_address_in_use. Adresses will
 206  *    mark the address as used an notify the solver about the use.
 207  *
 208  *       1.7.8 Address lifecycle
 209  *
 210  *      * (add address)
 211  *      * (updated address) || (address in use)
 212  *      * (delete address)
 213  *
 214  *     1.8 Bandwidth assignment
 215  *
 216  *    The addresses are used to perform resource allocation operations. ATS
 217  *    addresses takes care of instantiating the solver configured and notifies
 218  *    the respective solver about address changes and receives changes to the
 219  *    bandwidth assignment from the solver. The current bandwidth assignment is
 220  *    sent to transport. The specific solvers will be described in the specific
 221  *    section.
 222  *
 223  *     1.9 Changing peer preferences
 224  *
 225  *    The bandwidth assigned to a peer can be influenced by setting a preference
 226  *    for a peer. The prefernce will be given to to the solver with s_pref which
 227  *    has to take care of the preference value
 228
 229  */
 230
 231
 232 /**
 233  * Available ressource assignment modes
 234  */
 235 enum ATS_Mode
 236 {
 237   /*
 238    * Simplistic mode:
 239    *
 240    * Assign each peer an equal amount of bandwidth (bw)
 241    *
 242    * bw_per_peer = bw_total / #active addresses
 243    */
 244   MODE_SIMPLISTIC,
 245
 246   /*
 247    * MLP mode:
 248    *
 249    * Solve ressource assignment as an optimization problem
 250    * Uses an mixed integer programming solver
 251    */
 252   MODE_MLP
 253 };
 254
 255
 256 /**
 257  * Pending Address suggestion requests
 258  */
 259 struct GAS_Addresses_Suggestion_Requests
 260 {
 261   /**
 262    * Next in DLL
 263    */
 264   struct GAS_Addresses_Suggestion_Requests *next;
 265
 266   /**
 267    * Previous in DLL
 268    */
 269   struct GAS_Addresses_Suggestion_Requests *prev;
 270
 271   /**
 272    * Peer ID
 273    */
 274   struct GNUNET_PeerIdentity id;
 275 };
 276
 277
 278 /**
 279  * Handle for ATS address component
 280  */
 281 struct GAS_Addresses_Handle
 282 {
 283   /**
 284    *
 285    */
 286   struct GNUNET_STATISTICS_Handle *stat;
 287
 288   /**
 289    * A multihashmap to store all addresses
 290    */
 291   struct GNUNET_CONTAINER_MultiHashMap *addresses;
 292
 293   /**
 294    * Configure WAN quota in
 295    */
 296   unsigned long long wan_quota_in;
 297
 298   /**
 299    * Configure WAN quota out
 300    */
 301   unsigned long long wan_quota_out;
 302
 303   /**
 304    * Is ATS addresses running
 305    */
 306   int running;
 307
 308   /**
 309    * Configured ATS solver
 310    */
 311   int ats_mode;
 312
 313   /**
 314    *  Solver handle
 315    */
 316   void *solver;
 317
 318   /**
 319    * Address suggestion requests DLL head
 320    */
 321   struct GAS_Addresses_Suggestion_Requests *r_head;
 322
 323   /**
 324    * Address suggestion requests DLL tail
 325    */
 326   struct GAS_Addresses_Suggestion_Requests *r_tail;
 327
 328   /* Solver functions */
 329
 330   /**
 331    * Initialize solver
 332    */
 333   GAS_solver_init s_init;
 334
 335   /**
 336    * Add an address to the solver
 337    */
 338   GAS_solver_address_add s_add;
 339
 340   /**
 341    * Update address in solver
 342    */
 343   GAS_solver_address_update s_update;
 344
 345   /**
 346    * Get address from solver
 347    */
 348   GAS_solver_get_preferred_address s_get;
 349
 350   /**
 351    * Get address from solver
 352    */
 353   GAS_solver_stop_get_preferred_address s_get_stop;
 354
 355   /**
 356    * Delete address in solver
 357    */
 358   GAS_solver_address_delete s_del;
 359
 360   /**
 361    * Change preference for quality in solver
 362    */
 363   GAS_solver_address_change_preference s_pref;
 364
 365   /**
 366    * Shutdown solver
 367    */
 368   GAS_solver_done s_done;
 369 };
 370
 371
 372 /**
 373  * Assemble ATS information from address
 374  *
 375  * @param aa source address
 376  * @param dest destination
 377  * @return number of elements
 378  */
 379 static unsigned int
 380 assemble_ats_information (const struct ATS_Address *aa,  struct GNUNET_ATS_Information **dest)
 381 {
 382   unsigned int ats_count = GNUNET_ATS_PropertyCount - 1;
 383   struct GNUNET_ATS_Information *ats;
 384
 385   ats = GNUNET_malloc (ats_count * sizeof (struct GNUNET_ATS_Information));
 386   (*dest) = ats;
 387
 388   ats[0].type = ntohl(GNUNET_ATS_UTILIZATION_UP);
 389   ats[0].value = aa->atsp_utilization_out.value__;
 390   ats[1].type = ntohl(GNUNET_ATS_UTILIZATION_DOWN);
 391   ats[1].value = aa->atsp_utilization_in.value__;
 392   ats[2].type = ntohl(GNUNET_ATS_NETWORK_TYPE);
 393   ats[2].value = ntohl(aa->atsp_network_type);
 394   ats[3].type = ntohl(GNUNET_ATS_QUALITY_NET_DELAY);
 395   ats[3].value = ntohl(aa->atsp_latency.rel_value);
 396   ats[4].type = ntohl(GNUNET_ATS_QUALITY_NET_DISTANCE);
 397   ats[4].value = ntohl(aa->atsp_distance);
 398   ats[5].type = ntohl(GNUNET_ATS_COST_WAN);
 399   ats[5].value = ntohl (aa->atsp_cost_wan);
 400   ats[6].type = ntohl(GNUNET_ATS_COST_LAN);
 401   ats[6].value = ntohl (aa->atsp_cost_lan);
 402   ats[7].type = ntohl(GNUNET_ATS_COST_WLAN);
 403   ats[7].value = ntohl (aa->atsp_cost_wlan);
 404   return ats_count;
 405 }
 406
 407
 408 /**
 409  * Disassemble ATS information and update address
 410  *
 411  * @param src source ATS information
 412  * @param ats_count number of ATS information
 413  * @param dest destination address
 414  * @return GNUNET_YES if address was address updated, GNUNET_NO otherwise
 415  */
 416 static unsigned int
 417 disassemble_ats_information (const struct GNUNET_ATS_Information *src,
 418                              uint32_t ats_count,
 419                              struct ATS_Address *dest)
 420 {
 421   int i;
 422   int change = GNUNET_NO;
 423   int res = 0;
 424   for (i = 0; i < ats_count; i++)
 425     switch (ntohl (src[i].type))
 426     {
 427     case GNUNET_ATS_UTILIZATION_UP:
 428         if (dest->atsp_utilization_out.value__ != src[i].value)
 429                 change = GNUNET_YES;
 430       dest->atsp_utilization_out.value__ = src[i].value;
 431       res ++;
 432       break;
 433     case GNUNET_ATS_UTILIZATION_DOWN:
 434         if (dest->atsp_utilization_in.value__ != src[i].value)
 435                 change = GNUNET_YES;
 436       dest->atsp_utilization_in.value__ = src[i].value;
 437       res ++;
 438       break;
 439     case GNUNET_ATS_QUALITY_NET_DELAY:
 440         if (dest->atsp_latency.rel_value  != src[i].value)
 441                 change = GNUNET_YES;
 442       dest->atsp_latency.rel_value = ntohl (src[i].value);
 443       res ++;
 444       break;
 445     case GNUNET_ATS_QUALITY_NET_DISTANCE:
 446         if (dest->atsp_distance!= src[i].value)
 447                 change = GNUNET_YES;
 448       dest->atsp_distance = ntohl (src[i].value);
 449       res ++;
 450       break;
 451     case GNUNET_ATS_COST_WAN:
 452         if (dest->atsp_cost_wan != src[i].value)
 453                 change = GNUNET_YES;
 454       dest->atsp_cost_wan = ntohl (src[i].value);
 455       res ++;
 456       break;
 457     case GNUNET_ATS_COST_LAN:
 458         if (dest->atsp_cost_lan != src[i].value)
 459                 change = GNUNET_YES;
 460       dest->atsp_cost_lan = ntohl (src[i].value);
 461       res ++;
 462       break;
 463     case GNUNET_ATS_COST_WLAN:
 464         if (dest->atsp_cost_wlan != src[i].value)
 465                 change = GNUNET_YES;
 466       dest->atsp_cost_wlan = ntohl (src[i].value);
 467       res ++;
 468       break;
 469     case GNUNET_ATS_NETWORK_TYPE:
 470         if (dest->atsp_network_type != src[i].value)
 471                 change = GNUNET_YES;
 472       dest->atsp_network_type = ntohl (src[i].value);
 473       res ++;
 474       break;
 475     case GNUNET_ATS_ARRAY_TERMINATOR:
 476       break;
 477     default:
 478       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 479                   "Received unsupported ATS type %u\n", ntohl (src[i].type));
 480       GNUNET_break (0);
 481       break;
 482     }
 483   return change;
 484 }
 485
 486 /**
 487  * Free the given address
 488  * @param addr address to destroy
 489  */
 490 static void
 491 free_address (struct ATS_Address *addr)
 492 {
 493   GNUNET_free (addr->plugin);
 494   GNUNET_free (addr);
 495 }
 496
 497 /**
 498  * Create a ATS_address with the given information
 499  * @param peer peer
 500  * @param plugin_name plugin
 501  * @param plugin_addr address
 502  * @param plugin_addr_len address length
 503  * @param session_id session
 504  * @return the ATS_Address
 505  */
 506 static struct ATS_Address *
 507 create_address (const struct GNUNET_PeerIdentity *peer,
 508                 const char *plugin_name,
 509                 const void *plugin_addr, size_t plugin_addr_len,
 510                 uint32_t session_id)
 511 {
 512   struct ATS_Address *aa = NULL;
 513
 514   aa = GNUNET_malloc (sizeof (struct ATS_Address) + plugin_addr_len);
 515   aa->peer = *peer;
 516   aa->addr_len = plugin_addr_len;
 517   aa->addr = &aa[1];
 518   memcpy (&aa[1], plugin_addr, plugin_addr_len);
 519   aa->plugin = GNUNET_strdup (plugin_name);
 520   aa->session_id = session_id;
 521   aa->active = GNUNET_NO;
 522   aa->used = GNUNET_NO;
 523   aa->solver_information = NULL;
 524   aa->assigned_bw_in = GNUNET_BANDWIDTH_value_init(0);
 525   aa->assigned_bw_out = GNUNET_BANDWIDTH_value_init(0);
 526   return aa;
 527 }
 528
 529
 530 /**
 531  * Destroy the given address.
 532  *
 533  * @param handle the address handle
 534  * @param addr address to destroy
 535  * @return GNUNET_YES if bandwidth allocations should be recalcualted
 536  */
 537 static int
 538 destroy_address (struct GAS_Addresses_Handle *handle, struct ATS_Address *addr)
 539 {
 540   int ret;
 541
 542   ret = GNUNET_NO;
 543   GNUNET_assert (GNUNET_YES ==
 544                  GNUNET_CONTAINER_multihashmap_remove (handle->addresses,
 545                                                        &addr->peer.hashPubKey,
 546                                                        addr));
 547   free_address (addr);
 548   return ret;
 549 }
 550
 551
 552 struct CompareAddressContext
 553 {
 554   const struct ATS_Address *search;
 555
 556   /* exact_address != NULL if address and session is equal */
 557   struct ATS_Address *exact_address;
 558   /* exact_address != NULL if address and session is 0 */
 559   struct ATS_Address *base_address;
 560 };
 561
 562
 563 static int
 564 compare_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
 565 {
 566   struct CompareAddressContext *cac = cls;
 567   struct ATS_Address *aa = value;
 568
 569   /* Find an matching exact address:
 570    *
 571    * Compare by:
 572    * aa->addr_len == cac->search->addr_len
 573    * aa->plugin == cac->search->plugin
 574    * aa->addr == cac->search->addr
 575    * aa->session == cac->search->session
 576    *
 577    * return as exact address
 578    */
 579   if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
 580   {
 581       if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == cac->search->session_id))
 582         cac->exact_address = aa;
 583   }
 584
 585   /* Find an matching base address:
 586    *
 587    * Properties:
 588    *
 589    * aa->session_id == 0
 590    *
 591    * Compare by:
 592    * aa->addr_len == cac->search->addr_len
 593    * aa->plugin == cac->search->plugin
 594    * aa->addr == cac->search->addr
 595    *
 596    * return as base address
 597    */
 598   if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
 599   {
 600       if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == 0))
 601         cac->base_address = aa;
 602   }
 603
 604   /* Find an matching exact address based on session:
 605    *
 606    * Properties:
 607    *
 608    * cac->search->addr_len == 0
 609    *
 610    * Compare by:
 611    * aa->plugin == cac->search->plugin
 612    * aa->session_id == cac->search->session_id
 613    *
 614    * return as exact address
 615    */
 616   if (0 == cac->search->addr_len)
 617   {
 618       if ((0 == strcmp (aa->plugin, cac->search->plugin)) && (aa->session_id == cac->search->session_id))
 619         cac->exact_address = aa;
 620   }
 621
 622   if (cac->exact_address == NULL)
 623     return GNUNET_YES; /* Continue iteration to find exact address */
 624   else
 625     return GNUNET_NO; /* Stop iteration since we have an exact address */
 626 }
 627
 628
 629 /**
 630  * Find an existing equivalent address record.
 631  * Compares by peer identity and network address OR by session ID
 632  * (one of the two must match).
 633  *
 634  * @param handle the address handle
 635  * @param peer peer to lookup addresses for
 636  * @param addr existing address record
 637  * @return existing address record, NULL for none
 638  */
 639 struct ATS_Address *
 640 find_equivalent_address (struct GAS_Addresses_Handle *handle,
 641                          const struct GNUNET_PeerIdentity *peer,
 642                          const struct ATS_Address *addr)
 643 {
 644   struct CompareAddressContext cac;
 645
 646   cac.exact_address = NULL;
 647   cac.base_address = NULL;
 648   cac.search = addr;
 649   GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
 650                                               &compare_address_it, &cac);
 651
 652   if (cac.exact_address == NULL)
 653     return cac.base_address;
 654   return cac.exact_address;
 655 }
 656
 657
 658 static struct ATS_Address *
 659 lookup_address (struct GAS_Addresses_Handle *handle,
 660                 const struct GNUNET_PeerIdentity *peer,
 661                 const char *plugin_name,
 662                 const void *plugin_addr,
 663                 size_t plugin_addr_len,
 664                 uint32_t session_id,
 665                 const struct GNUNET_ATS_Information *atsi,
 666                 uint32_t atsi_count)
 667 {
 668   struct ATS_Address *aa;
 669   struct ATS_Address *ea;
 670
 671   aa = create_address (peer,
 672                        plugin_name,
 673                        plugin_addr, plugin_addr_len,
 674                        session_id);
 675
 676   /* Get existing address or address with session == 0 */
 677   ea = find_equivalent_address (handle, peer, aa);
 678   free_address (aa);
 679   if (ea == NULL)
 680   {
 681     return NULL;
 682   }
 683   else if (ea->session_id != session_id)
 684   {
 685     return NULL;
 686   }
 687   return ea;
 688 }
 689
 690
 691
 692 /**
 693  * Add a new address for a peer.
 694  *
 695  * @param handle the address handle to use
 696  * @param peer peer
 697  * @param plugin_name transport plugin name
 698  * @param plugin_addr plugin address
 699  * @param plugin_addr_len length of the plugin address
 700  * @param session_id session id, can be 0
 701  * @param atsi performance information for this address
 702  * @param atsi_count number of performance information contained
 703  */
 704 void
 705 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
 706                    const struct GNUNET_PeerIdentity *peer,
 707                    const char *plugin_name, const void *plugin_addr,
 708                    size_t plugin_addr_len, uint32_t session_id,
 709                    const struct GNUNET_ATS_Information *atsi,
 710                    uint32_t atsi_count)
 711 {
 712   struct ATS_Address *aa;
 713   struct ATS_Address *ea;
 714   struct GNUNET_ATS_Information *ats_new;
 715   uint32_t ats_count_new;
 716   unsigned int ats_res;
 717
 718   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 719               "Received `%s' for peer `%s'\n",
 720               "ADDRESS ADD",
 721               GNUNET_i2s (peer));
 722
 723   if (GNUNET_NO == handle->running)
 724     return;
 725
 726   GNUNET_assert (NULL != handle->addresses);
 727
 728   aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len,
 729                        session_id);
 730
 731   if (atsi_count != (ats_res = disassemble_ats_information(atsi, atsi_count, aa)))
 732   {
 733       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 734                 "While adding address: had %u ATS elements to add, could only add %u\n",
 735                 atsi_count, ats_res);
 736   }
 737
 738   /* Get existing address or address with session == 0 */
 739   ea = find_equivalent_address (handle, peer, aa);
 740   if (ea == NULL)
 741   {
 742     /* We have a new address */
 743     GNUNET_assert (GNUNET_OK ==
 744                    GNUNET_CONTAINER_multihashmap_put (handle->addresses,
 745                                                       &peer->hashPubKey, aa,
 746                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
 747     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Added new address for peer `%s' session id %u, %p\n",
 748                 GNUNET_i2s (peer), session_id, aa);
 749     /* Tell solver about new address */
 750     handle->s_add (handle->solver, handle->addresses, aa);
 751     /* Notify performance clients about new address */
 752     ats_count_new = assemble_ats_information (aa, &ats_new);
 753     GAS_performance_notify_all_clients (&aa->peer,
 754         aa->plugin,
 755         aa->addr, aa->addr_len,
 756         aa->session_id,
 757         ats_new, ats_count_new,
 758         aa->assigned_bw_out,
 759         aa->assigned_bw_in);
 760     GNUNET_free (ats_new);
 761     return;
 762   }
 763   GNUNET_free (aa->plugin);
 764   GNUNET_free (aa);
 765
 766   if (ea->session_id != 0)
 767   {
 768       /* This address with the same session is already existing
 769        * Should not happen */
 770       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 771                 "Added already existing address for peer `%s' `%s' %p with new session %u\n",
 772                 GNUNET_i2s (peer), plugin_name, session_id);
 773       GNUNET_break (0);
 774       return;
 775   }
 776
 777   /* We have an address without an session, update this address */
 778
 779   /* Notify solver about update with atsi information and session */
 780   handle->s_update (handle->solver, handle->addresses, ea, session_id, ea->used, atsi, atsi_count);
 781
 782   /* Do the update */
 783   ea->session_id = session_id;
 784   if (GNUNET_YES == disassemble_ats_information(atsi, atsi_count, ea))
 785   {
 786                 ats_count_new = assemble_ats_information (aa, &ats_new);
 787                 GAS_performance_notify_all_clients (&aa->peer,
 788                                 aa->plugin,
 789                                 aa->addr, aa->addr_len,
 790                                 aa->session_id,
 791                                 ats_new, ats_count_new,
 792                                 aa->assigned_bw_out,
 793                                 aa->assigned_bw_in);
 794                 GNUNET_free (ats_new);
 795   }
 796   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 797            "Updated existing address for peer `%s' %p with new session %u\n",
 798            GNUNET_i2s (peer), ea, session_id);
 799 }
 800
 801
 802 /**
 803  * Update an address with a session or performance information for a peer.
 804  *
 805  * If an address was added without a session it will be updated with the
 806  * session
 807  *
 808  * @param handle the address handle to use
 809  * @param peer peer
 810  * @param plugin_name transport plugin name
 811  * @param plugin_addr plugin address
 812  * @param plugin_addr_len length of the plugin address
 813  * @param session_id session id, can be 0
 814  * @param atsi performance information for this address
 815  * @param atsi_count number of performance information contained
 816  */
 817 void
 818 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
 819                       const struct GNUNET_PeerIdentity *peer,
 820                       const char *plugin_name, const void *plugin_addr,
 821                       size_t plugin_addr_len, uint32_t session_id,
 822                       const struct GNUNET_ATS_Information *atsi,
 823                       uint32_t atsi_count)
 824 {
 825   struct ATS_Address *aa;
 826   struct GNUNET_ATS_Information *ats_new;
 827   uint32_t ats_count_new;
 828
 829   if (GNUNET_NO == handle->running)
 830     return;
 831
 832   GNUNET_assert (NULL != handle->addresses);
 833
 834   /* Get existing address */
 835   aa = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
 836                        session_id, atsi, atsi_count);
 837   if (aa == NULL)
 838   {
 839     /* GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n", */
 840     /*             GNUNET_i2s (peer), plugin_name, session_id); */
 841     /* GNUNET_break (0); */
 842     return;
 843   }
 844
 845   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 846                 "Received `%s' for peer `%s' address \n",
 847                 "ADDRESS UPDATE",
 848                 GNUNET_i2s (peer), aa);
 849
 850   /* Tell solver about update */
 851   handle->s_update (handle->solver, handle->addresses, aa, session_id, aa->used, atsi, atsi_count);
 852
 853   /* Update address */
 854   if (GNUNET_YES == disassemble_ats_information (atsi, atsi_count, aa))
 855   {
 856                 ats_count_new = assemble_ats_information (aa, &ats_new);
 857                 /* Notify performance clients about updated address */
 858                 GAS_performance_notify_all_clients (&aa->peer,
 859                                 aa->plugin,
 860                                 aa->addr, aa->addr_len,
 861                                 aa->session_id,
 862                                 ats_new, ats_count_new,
 863                                 aa->assigned_bw_out,
 864                                 aa->assigned_bw_in);
 865                 GNUNET_free (ats_new);
 866   }
 867 }
 868
 869
 870 struct DestroyContext
 871 {
 872   struct ATS_Address *aa;
 873
 874   struct GAS_Addresses_Handle *handle;
 875
 876   /**
 877    * GNUNET_NO  : full address
 878    * GNUNET_YES : just session
 879    */
 880   int result;
 881 };
 882
 883
 884 /**
 885  * Delete an address
 886  *
 887  * If session != 0, just the session is deleted, the address itself still exists
 888  * If session == 0, remove full address
 889  * If session == 0 and addrlen == 0, destroy inbound address
 890  *
 891  * @param cls unused
 892  * @param key unused
 893  * @param value the 'struct ATS_Address'
 894  * @return GNUNET_OK (continue to iterate)
 895  */
 896 static int
 897 destroy_by_session_id (void *cls, const struct GNUNET_HashCode * key, void *value)
 898 {
 899   struct DestroyContext *dc = cls;
 900   struct GAS_Addresses_Handle *handle = dc->handle;
 901   const struct ATS_Address *des = dc->aa;
 902   struct ATS_Address *aa = value;
 903
 904   GNUNET_assert (0 == memcmp (&aa->peer, &des->peer,
 905                               sizeof (struct GNUNET_PeerIdentity)));
 906
 907
 908   if (des->session_id == 0)
 909   {
 910     /* Session == 0, remove full address  */
 911     if ((0 == strcmp (des->plugin, aa->plugin)) &&
 912         (aa->addr_len == des->addr_len) &&
 913         (0 == memcmp (des->addr, aa->addr, aa->addr_len)))
 914     {
 915
 916       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 917                   "Deleting full address for peer `%s' session %u %p\n",
 918                   GNUNET_i2s (&aa->peer), aa->session_id, aa);
 919
 920       /* Notify solver about deletion */
 921       handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
 922       destroy_address (handle, aa);
 923       dc->result = GNUNET_NO;
 924       return GNUNET_OK; /* Continue iteration */
 925     }
 926   }
 927   else
 928   {
 929     /* Session != 0, just remove session */
 930     if (aa->session_id != des->session_id)
 931       return GNUNET_OK; /* irrelevant */
 932
 933     if ((aa->session_id != 0) &&
 934         (0 != strcmp (des->plugin, aa->plugin)))
 935     {
 936         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 937                     "Different plugins during removal: `%s' vs `%s' \n",
 938                     des->plugin, aa->plugin);
 939         GNUNET_break (0);
 940         return GNUNET_OK;
 941     }
 942
 943     if (aa->addr_len == 0)
 944     {
 945         /* Inbound connection died, delete full address */
 946         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 947                     "Deleting inbound address for peer `%s': `%s' session %u\n",
 948                     GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
 949
 950         /* Notify solver about deletion */
 951         handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
 952         destroy_address (handle, aa);
 953         dc->result = GNUNET_NO;
 954         return GNUNET_OK; /* Continue iteration */
 955     }
 956     else
 957     {
 958         /* Session died */
 959         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 960                     "Deleting session for peer `%s': `%s' %u\n",
 961                     GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
 962         /* Notify solver to delete session */
 963         handle->s_del (handle->solver, handle->addresses, aa, GNUNET_YES);
 964         aa->session_id = 0;
 965         return GNUNET_OK;
 966     }
 967   }
 968   return GNUNET_OK;
 969 }
 970
 971
 972 /**
 973  * Remove an address or just a session for a peer.
 974  *
 975  * @param handle the address handle to use
 976  * @param peer peer
 977  * @param plugin_name transport plugin name
 978  * @param plugin_addr plugin address
 979  * @param plugin_addr_len length of the plugin address
 980  * @param session_id session id, can be 0
 981  */
 982 void
 983 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
 984                        const struct GNUNET_PeerIdentity *peer,
 985                        const char *plugin_name,
 986                        const void *plugin_addr,
 987                        size_t plugin_addr_len,
 988                        uint32_t session_id)
 989 {
 990   struct ATS_Address *ea;
 991   struct DestroyContext dc;
 992
 993   if (GNUNET_NO == handle->running)
 994     return;
 995
 996   /* Get existing address */
 997   ea = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
 998                        session_id, NULL, 0);
 999
1000   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1001               "Received `%s' for peer `%s' address %p session %u\n",
1002               "ADDRESS DESTROY",
1003               GNUNET_i2s (peer), ea, session_id);
1004
1005   if (ea == NULL)
1006   {
1007     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Tried to destroy unknown address for peer `%s' `%s' session id %u\n",
1008                 GNUNET_i2s (peer), plugin_name, session_id);
1009     return;
1010   }
1011
1012   GNUNET_break (0 < strlen (plugin_name));
1013   dc.handle = handle;
1014   dc.aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len, session_id);
1015
1016   GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
1017                                               &destroy_by_session_id, &dc);
1018   free_address (dc.aa);
1019 }
1020
1021
1022 /**
1023  * Notification about active use of an address.
1024  * in_use == GNUNET_YES:
1025  *      This address is used to maintain an active connection with a peer.
1026  * in_use == GNUNET_NO:
1027  *      This address is no longer used to maintain an active connection with a peer.
1028  *
1029  * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
1030  * before
1031  *
1032  * @param handle the address handle to use
1033  * @param peer peer
1034  * @param plugin_name transport plugin name
1035  * @param plugin_addr plugin address
1036  * @param plugin_addr_len length of the plugin address
1037  * @param session_id session id, can be 0
1038  * @param in_use GNUNET_YES if GNUNET_NO
1039  * @return GNUNET_SYSERR on failure (address unknown ...)
1040  */
1041 int
1042 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
1043                       const struct GNUNET_PeerIdentity *peer,
1044                       const char *plugin_name,
1045                       const void *plugin_addr,
1046                       size_t plugin_addr_len,
1047                       uint32_t session_id,
1048                       int in_use)
1049 {
1050   struct ATS_Address *ea;
1051
1052   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1053                 "Received `%s' for peer `%s'\n",
1054                 "ADDRESS IN USE",
1055                 GNUNET_i2s (peer));
1056
1057   if (GNUNET_NO == handle->running)
1058     return GNUNET_SYSERR;
1059
1060   ea = lookup_address (handle, peer, plugin_name,
1061                         plugin_addr, plugin_addr_len,
1062                         session_id, NULL, 0);
1063   if (NULL == ea)
1064   {
1065     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1066                 "Trying to set unknown address `%s', %s %u %s \n",
1067                 GNUNET_i2s (peer),
1068                 plugin_name, session_id,
1069                 (GNUNET_NO == in_use) ? "NO" : "YES");
1070     GNUNET_break (0);
1071     return GNUNET_SYSERR;
1072   }
1073   if (ea->used == in_use)
1074   {
1075     GNUNET_break (0);
1076     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1077                 "Address in use called multiple times for peer `%s': %s -> %s \n",
1078                 GNUNET_i2s (peer),
1079                 (GNUNET_NO == ea->used) ? "NO" : "YES",
1080                 (GNUNET_NO == in_use) ? "NO" : "YES");
1081     return GNUNET_SYSERR;
1082   }
1083
1084   /* Tell solver about update */
1085   handle->s_update (handle->solver, handle->addresses, ea, session_id, in_use, NULL, 0);
1086   ea->used = in_use;
1087
1088   return GNUNET_OK;
1089 }
1090
1091
1092 /**
1093  * Cancel address suggestions for a peer
1094  *
1095  * @param handle the address handle
1096  * @param peer the peer id
1097  */
1098 void
1099 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
1100                                       const struct GNUNET_PeerIdentity *peer)
1101 {
1102   struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1103
1104   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1105               "Received request: `%s' for peer %s\n", "request_address_cancel", GNUNET_i2s (peer));
1106
1107   while (NULL != cur)
1108   {
1109       if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1110         break; /* found */
1111       cur = cur->next;
1112   }
1113
1114   if (NULL == cur)
1115   {
1116       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1117                   "No address requests pending for peer `%s', cannot remove!\n", GNUNET_i2s (peer));
1118       return;
1119   }
1120   handle->s_get_stop (handle->solver, handle->addresses, peer);
1121   GAS_addresses_handle_backoff_reset (handle, peer);
1122   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1123               "Removed request pending for peer `%s\n", GNUNET_i2s (peer));
1124   GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1125   GNUNET_free (cur);
1126 }
1127
1128
1129 /**
1130  * Request address suggestions for a peer
1131  *
1132  * @param handle the address handle
1133  * @param peer the peer id
1134  */
1135 void
1136 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
1137                                const struct GNUNET_PeerIdentity *peer)
1138 {
1139   struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1140   struct ATS_Address *aa;
1141   struct GNUNET_ATS_Information *ats;
1142   unsigned int ats_count;
1143
1144   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1145               "Received `%s' for peer `%s'\n",
1146               "REQUEST ADDRESS",
1147               GNUNET_i2s (peer));
1148
1149   if (GNUNET_NO == handle->running)
1150     return;
1151   while (NULL != cur)
1152   {
1153       if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1154         break; /* already suggesting */
1155       cur = cur->next;
1156   }
1157   if (NULL == cur)
1158   {
1159       cur = GNUNET_malloc (sizeof (struct GAS_Addresses_Suggestion_Requests));
1160       cur->id = (*peer);
1161       GNUNET_CONTAINER_DLL_insert (handle->r_head, handle->r_tail, cur);
1162   }
1163
1164   /* Get prefered address from solver */
1165   aa = (struct ATS_Address *) handle->s_get (handle->solver, handle->addresses, peer);
1166   if (NULL == aa)
1167   {
1168     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1169                 "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
1170     return;
1171   }
1172
1173   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1174               "Suggesting address %p for peer `%s'\n", aa, GNUNET_i2s (peer));
1175
1176   ats_count = assemble_ats_information (aa, &ats);
1177   GAS_scheduling_transmit_address_suggestion (peer,
1178                                               aa->plugin,
1179                                               aa->addr, aa->addr_len,
1180                                               aa->session_id,
1181                                               ats, ats_count,
1182                                               aa->assigned_bw_out,
1183                                               aa->assigned_bw_in);
1184
1185   aa->block_interval = GNUNET_TIME_relative_add (aa->block_interval, ATS_BLOCKING_DELTA);
1186   aa->blocked_until = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(), aa->block_interval);
1187
1188   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1189        "Address %p ready for suggestion, block interval now %llu \n",
1190        aa, aa->block_interval);
1191
1192   GNUNET_free (ats);
1193 }
1194
1195
1196 static int
1197 reset_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1198 {
1199   struct ATS_Address *aa = value;
1200
1201   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1202               "Resetting interval for peer `%s' address %p from %llu to 0\n",
1203               GNUNET_i2s (&aa->peer), aa, aa->block_interval);
1204
1205   aa->blocked_until = GNUNET_TIME_UNIT_ZERO_ABS;
1206   aa->block_interval = GNUNET_TIME_UNIT_ZERO;
1207   return GNUNET_OK;
1208 }
1209
1210
1211 /**
1212  * Reset suggestion backoff for a peer
1213  *
1214  * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
1215  * reset using this function
1216  *
1217  * @param handle the address handle
1218  * @param peer the peer id
1219  */
1220 void
1221 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
1222                                     const struct GNUNET_PeerIdentity *peer)
1223 {
1224   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1225               "Received `%s' for peer `%s'\n",
1226               "RESET BACKOFF",
1227               GNUNET_i2s (peer));
1228
1229   GNUNET_break (GNUNET_SYSERR != GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses,
1230                                               &peer->hashPubKey,
1231                                               &reset_address_it,
1232                                               NULL));
1233 }
1234
1235
1236 /**
1237  * Change the preference for a peer
1238  *
1239  * @param handle the address handle
1240  * @param client the client sending this request
1241  * @param peer the peer id
1242  * @param kind the preference kind to change
1243  * @param score the new preference score
1244  */
1245 void
1246 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
1247                                  void *client,
1248                                  const struct GNUNET_PeerIdentity *peer,
1249                                  enum GNUNET_ATS_PreferenceKind kind,
1250                                  float score)
1251 {
1252   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1253               "Received `%s' for peer `%s' for client %p\n",
1254               "CHANGE PREFERENCE",
1255               GNUNET_i2s (peer), client);
1256
1257   if (GNUNET_NO == handle->running)
1258     return;
1259
1260   if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains (handle->addresses,
1261                                                           &peer->hashPubKey))
1262   {
1263       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1264                   "Received `%s' for unknown peer `%s' from client %p\n",
1265                   "CHANGE PREFERENCE",
1266                   GNUNET_i2s (peer), client);
1267       return;
1268   }
1269
1270   /* Tell solver about update */
1271   handle->s_pref (handle->solver, client, peer, kind, score);
1272 }
1273
1274
1275 /**
1276  * Load quotas for networks from configuration
1277  *
1278  * @param cfg configuration handle
1279  * @param out_dest where to write outbound quotas
1280  * @param in_dest where to write inbound quotas
1281  * @param dest_length length of inbound and outbound arrays
1282  * @return number of networks loaded
1283  */
1284 static unsigned int
1285 load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned long long *out_dest, unsigned long long *in_dest, int dest_length)
1286 {
1287   char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1288   char * entry_in = NULL;
1289   char * entry_out = NULL;
1290   char * quota_out_str;
1291   char * quota_in_str;
1292   int c;
1293   int res;
1294
1295   for (c = 0; (c < GNUNET_ATS_NetworkTypeCount) && (c < dest_length); c++)
1296   {
1297     in_dest[c] = 0;
1298     out_dest[c] = 0;
1299     GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
1300     GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
1301
1302     /* quota out */
1303     if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_out, &quota_out_str))
1304     {
1305       res = GNUNET_NO;
1306       if (0 == strcmp(quota_out_str, GNUNET_ATS_MaxBandwidthString))
1307       {
1308         out_dest[c] = GNUNET_ATS_MaxBandwidth;
1309         res = GNUNET_YES;
1310       }
1311       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, &out_dest[c])))
1312         res = GNUNET_YES;
1313       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_out,  &out_dest[c])))
1314          res = GNUNET_YES;
1315
1316       if (GNUNET_NO == res)
1317       {
1318           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s':  `%s', assigning default bandwidth %llu\n"),
1319               network_str[c], quota_out_str, GNUNET_ATS_DefaultBandwidth);
1320           out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1321       }
1322       else
1323       {
1324           GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Outbound quota configure for network `%s' is %llu\n"),
1325               network_str[c], out_dest[c]);
1326       }
1327       GNUNET_free (quota_out_str);
1328     }
1329     else
1330     {
1331       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configured for network `%s', assigning default bandwidth %llu\n"),
1332           network_str[c], GNUNET_ATS_DefaultBandwidth);
1333       out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1334     }
1335
1336     /* quota in */
1337     if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_in, &quota_in_str))
1338     {
1339       res = GNUNET_NO;
1340       if (0 == strcmp(quota_in_str, GNUNET_ATS_MaxBandwidthString))
1341       {
1342         in_dest[c] = GNUNET_ATS_MaxBandwidth;
1343         res = GNUNET_YES;
1344       }
1345       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, &in_dest[c])))
1346         res = GNUNET_YES;
1347       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_in,  &in_dest[c])))
1348          res = GNUNET_YES;
1349
1350       if (GNUNET_NO == res)
1351       {
1352           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s':  `%s', assigning default bandwidth %llu\n"),
1353               network_str[c], quota_in_str, GNUNET_ATS_DefaultBandwidth);
1354           in_dest[c] = GNUNET_ATS_DefaultBandwidth;
1355       }
1356       else
1357       {
1358           GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Inbound quota configured for network `%s' is %llu\n"),
1359               network_str[c], in_dest[c]);
1360       }
1361       GNUNET_free (quota_in_str);
1362     }
1363     else
1364     {
1365       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configure for network `%s', assigning default bandwidth %llu\n"),
1366           network_str[c], GNUNET_ATS_DefaultBandwidth);
1367       out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1368     }
1369     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Loaded quota for network `%s' (in/out): %llu %llu\n", network_str[c], in_dest[c], out_dest[c]);
1370     GNUNET_free (entry_out);
1371     GNUNET_free (entry_in);
1372   }
1373   return GNUNET_ATS_NetworkTypeCount;
1374 }
1375
1376
1377 static void
1378 bandwidth_changed_cb (void *cls, struct ATS_Address *address)
1379 {
1380   struct GAS_Addresses_Handle *handle = cls;
1381   struct GAS_Addresses_Suggestion_Requests *cur;
1382   struct GNUNET_ATS_Information *ats;
1383   unsigned int ats_count;
1384
1385   GNUNET_assert (handle != NULL);
1386   GNUNET_assert (address != NULL);
1387
1388   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Bandwidth assignment changed for peer %s \n", GNUNET_i2s(&address->peer));
1389
1390
1391   ats_count = assemble_ats_information (address, &ats);
1392
1393   /* Notify performance clients about changes to address */
1394   GAS_performance_notify_all_clients (&address->peer,
1395       address->plugin,
1396       address->addr, address->addr_len,
1397       address->session_id,
1398       ats, ats_count,
1399       address->assigned_bw_out,
1400       address->assigned_bw_in);
1401   cur = handle->r_head;
1402   while (NULL != cur)
1403   {
1404       if (0 == memcmp (&address->peer, &cur->id, sizeof (cur->id)))
1405         break; /* we have an address request pending*/
1406       cur = cur->next;
1407   }
1408   if (NULL == cur)
1409   {
1410       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1411                   "Nobody is interested in peer `%s' :(\n",GNUNET_i2s (&address->peer));
1412       GNUNET_free (ats);
1413       return;
1414   }
1415
1416   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1417               "Sending bandwidth update for peer `%s'\n",GNUNET_i2s (&address->peer));
1418
1419   /* *Notify scheduling clients about suggestion */
1420   GAS_scheduling_transmit_address_suggestion (&address->peer,
1421                                               address->plugin,
1422                                               address->addr, address->addr_len,
1423                                               address->session_id,
1424                                               ats, ats_count,
1425                                               address->assigned_bw_out,
1426                                               address->assigned_bw_in);
1427   GNUNET_free (ats);
1428 }
1429
1430
1431 /**
1432  * Initialize address subsystem. The addresses subsystem manages the addresses
1433  * known and current performance information. It has a solver component
1434  * responsible for the resource allocation. It tells the solver about changes
1435  * and receives updates when the solver changes the ressource allocation.
1436  *
1437  * @param cfg configuration to use
1438  * @param stats the statistics handle to use
1439  * @return an address handle
1440  */
1441 struct GAS_Addresses_Handle *
1442 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1443                     const struct GNUNET_STATISTICS_Handle *stats)
1444 {
1445   struct GAS_Addresses_Handle *ah;
1446   int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1447   unsigned long long  quotas_in[GNUNET_ATS_NetworkTypeCount];
1448   unsigned long long  quotas_out[GNUNET_ATS_NetworkTypeCount];
1449   int quota_count;
1450   char *mode_str;
1451   int c;
1452
1453   ah = GNUNET_malloc (sizeof (struct GAS_Addresses_Handle));
1454   ah->running = GNUNET_NO;
1455
1456   ah->stat = (struct GNUNET_STATISTICS_Handle *) stats;
1457   /* Initialize the addresses database */
1458   ah->addresses = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
1459   GNUNET_assert (NULL != ah->addresses);
1460
1461   /* Figure out configured solution method */
1462   if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", "MODE", &mode_str))
1463   {
1464       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "No ressource assignment method configured, using simplistic approch\n");
1465       ah->ats_mode = MODE_SIMPLISTIC;
1466   }
1467   else
1468   {
1469       for (c = 0; c < strlen (mode_str); c++)
1470         mode_str[c] = toupper (mode_str[c]);
1471       if (0 == strcmp (mode_str, "SIMPLISTIC"))
1472       {
1473           ah->ats_mode = MODE_SIMPLISTIC;
1474       }
1475       else if (0 == strcmp (mode_str, "MLP"))
1476       {
1477           ah->ats_mode = MODE_MLP;
1478 #if !HAVE_LIBGLPK
1479           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Assignment method `%s' configured, but GLPK is not availabe, please install \n", mode_str);
1480           ah->ats_mode = MODE_SIMPLISTIC;
1481 #endif
1482       }
1483       else
1484       {
1485           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Invalid ressource assignment method `%s' configured, using simplistic approch\n", mode_str);
1486           ah->ats_mode = MODE_SIMPLISTIC;
1487       }
1488       GNUNET_free (mode_str);
1489   }
1490   /* Start configured solution method */
1491   switch (ah->ats_mode)
1492   {
1493     case MODE_MLP:
1494       /* Init the MLP solver with default values */
1495 #if HAVE_LIBGLPK
1496       ah->ats_mode = MODE_MLP;
1497       ah->s_init = &GAS_mlp_init;
1498       ah->s_add = &GAS_mlp_address_add;
1499       ah->s_update = &GAS_mlp_address_update;
1500       ah->s_get = &GAS_mlp_get_preferred_address;
1501       ah->s_get_stop = &GAS_mlp_stop_get_preferred_address;
1502       ah->s_pref = &GAS_mlp_address_change_preference;
1503       ah->s_del =  &GAS_mlp_address_delete;
1504       ah->s_done = &GAS_mlp_done;
1505 #else
1506       GNUNET_free (ah);
1507       return NULL;
1508 #endif
1509       break;
1510     case MODE_SIMPLISTIC:
1511       /* Init the simplistic solver with default values */
1512       ah->ats_mode = MODE_SIMPLISTIC;
1513       ah->s_init = &GAS_simplistic_init;
1514       ah->s_add = &GAS_simplistic_address_add;
1515       ah->s_update = &GAS_simplistic_address_update;
1516       ah->s_get = &GAS_simplistic_get_preferred_address;
1517       ah->s_get_stop = &GAS_simplistic_stop_get_preferred_address;
1518       ah->s_pref = &GAS_simplistic_address_change_preference;
1519       ah->s_del  = &GAS_simplistic_address_delete;
1520       ah->s_done = &GAS_simplistic_done;
1521       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ATS started in %s mode\n", "SIMPLISTIC");
1522       break;
1523     default:
1524       return NULL;
1525       break;
1526   }
1527
1528   GNUNET_assert (NULL != ah->s_init);
1529   GNUNET_assert (NULL != ah->s_add);
1530   GNUNET_assert (NULL != ah->s_update);
1531   GNUNET_assert (NULL != ah->s_get);
1532   GNUNET_assert (NULL != ah->s_get_stop);
1533   GNUNET_assert (NULL != ah->s_pref);
1534   GNUNET_assert (NULL != ah->s_del);
1535   GNUNET_assert (NULL != ah->s_done);
1536
1537   quota_count = load_quotas(cfg, quotas_in, quotas_out, GNUNET_ATS_NetworkTypeCount);
1538
1539   ah->solver = ah->s_init (cfg, stats, quotas, quotas_in, quotas_out, quota_count, &bandwidth_changed_cb, ah);
1540   if (NULL == ah->solver)
1541   {
1542     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Failed to initialize solver!\n");
1543     GNUNET_free (ah);
1544     return NULL;
1545   }
1546
1547   /* up and running */
1548   ah->running = GNUNET_YES;
1549   return ah;
1550 }
1551
1552
1553 /**
1554  * Free memory of address.
1555  *
1556  * @param cls NULL
1557  * @param key peer identity (unused)
1558  * @param value the 'struct ATS_Address' to free
1559  * @return GNUNET_OK (continue to iterate)
1560  */
1561 static int
1562 free_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1563 {
1564   struct GAS_Addresses_Handle *handle = cls;
1565   struct ATS_Address *aa = value;
1566   handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
1567   destroy_address (handle, aa);
1568   return GNUNET_OK;
1569 }
1570
1571
1572 /**
1573  * Remove all addresses
1574  *
1575  * @param handle the address handle to use
1576  */
1577 void
1578 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle)
1579 {
1580   if (GNUNET_NO == handle->running)
1581     return;
1582
1583   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1584               "Received `%s'\n",
1585               "DESTROY ALL");
1586
1587   if (handle->addresses != NULL)
1588     GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &free_address_it, handle);
1589 }
1590
1591
1592 /**
1593  * Shutdown address subsystem.
1594  *
1595  * @param handle the address handle to shutdown
1596  */
1597 void
1598 GAS_addresses_done (struct GAS_Addresses_Handle *handle)
1599 {
1600   struct GAS_Addresses_Suggestion_Requests *cur;
1601
1602   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1603               "Shutting down addresses\n");
1604   GNUNET_assert (NULL != handle);
1605   GAS_addresses_destroy_all (handle);
1606   handle->running = GNUNET_NO;
1607   GNUNET_CONTAINER_multihashmap_destroy (handle->addresses);
1608   handle->addresses = NULL;
1609   while (NULL != (cur = handle->r_head))
1610   {
1611       GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1612       GNUNET_free (cur);
1613   }
1614   handle->s_done (handle->solver);
1615   GNUNET_free (handle);
1616   /* Stop configured solution method */
1617
1618 }
1619
1620 struct PeerIteratorContext
1621 {
1622   GNUNET_ATS_Peer_Iterator it;
1623   void *it_cls;
1624   struct GNUNET_CONTAINER_MultiHashMap *peers_returned;
1625 };
1626
1627 static int
1628 peer_it (void *cls,
1629          const struct GNUNET_HashCode * key,
1630          void *value)
1631 {
1632   struct PeerIteratorContext *ip_ctx = cls;
1633   struct GNUNET_PeerIdentity tmp;
1634
1635   if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(ip_ctx->peers_returned, key))
1636   {
1637       GNUNET_CONTAINER_multihashmap_put(ip_ctx->peers_returned, key, NULL, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1638       tmp.hashPubKey = (*key);
1639       ip_ctx->it (ip_ctx->it_cls, &tmp);
1640   }
1641
1642   return GNUNET_OK;
1643 }
1644
1645
1646 /**
1647  * Return information all peers currently known to ATS
1648  *
1649  * @param handle the address handle to use
1650  * @param p_it the iterator to call for every peer
1651  * @param p_it_cls the closure for the iterator
1652  */
1653 void
1654 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
1655                                                                                                                  GNUNET_ATS_Peer_Iterator p_it,
1656                                                                                                                  void *p_it_cls)
1657 {
1658   struct PeerIteratorContext ip_ctx;
1659   unsigned int size;
1660
1661   if (NULL == p_it)
1662       return;
1663   GNUNET_assert (NULL != handle->addresses);
1664
1665   size = GNUNET_CONTAINER_multihashmap_size(handle->addresses);
1666   if (0 != size)
1667   {
1668     ip_ctx.it = p_it;
1669     ip_ctx.it_cls = p_it_cls;
1670     ip_ctx.peers_returned = GNUNET_CONTAINER_multihashmap_create (size, GNUNET_NO);
1671     GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &peer_it, &ip_ctx);
1672     GNUNET_CONTAINER_multihashmap_destroy (ip_ctx.peers_returned);
1673   }
1674   p_it (p_it_cls, NULL);
1675 }
1676
1677
1678 struct PeerInfoIteratorContext
1679 {
1680   GNUNET_ATS_PeerInfo_Iterator it;
1681   void *it_cls;
1682 };
1683
1684
1685 static int
1686 peerinfo_it (void *cls,
1687              const struct GNUNET_HashCode * key,
1688              void *value)
1689 {
1690   struct PeerInfoIteratorContext *pi_ctx = cls;
1691   struct ATS_Address *addr = (struct ATS_Address *)  value;
1692   struct GNUNET_ATS_Information *ats;
1693   uint32_t ats_count;
1694
1695   if (NULL != pi_ctx->it)
1696   {
1697     ats_count = assemble_ats_information (addr, &ats);
1698
1699     pi_ctx->it (pi_ctx->it_cls,
1700                 &addr->peer,
1701                 addr->plugin,
1702                 addr->addr, addr->addr_len,
1703                 addr->active,
1704                 ats, ats_count,
1705                 addr->assigned_bw_out,
1706                 addr->assigned_bw_in);
1707     GNUNET_free (ats);
1708   }
1709   return GNUNET_YES;
1710 }
1711
1712
1713 /**
1714  * Return information all peers currently known to ATS
1715  *
1716  * @param handle the address handle to use
1717  * @param peer the respective peer
1718  * @param pi_it the iterator to call for every peer
1719  * @param pi_it_cls the closure for the iterator
1720  */
1721 void
1722 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
1723                              const struct GNUNET_PeerIdentity *peer,
1724                              GNUNET_ATS_PeerInfo_Iterator pi_it,
1725                              void *pi_it_cls)
1726 {
1727   struct PeerInfoIteratorContext pi_ctx;
1728   struct GNUNET_BANDWIDTH_Value32NBO zero_bw;
1729   GNUNET_assert (NULL != peer);
1730   GNUNET_assert (NULL != handle->addresses);
1731   if (NULL == pi_it)
1732     return; /* does not make sense without callback */
1733
1734   zero_bw = GNUNET_BANDWIDTH_value_init (0);
1735   pi_ctx.it = pi_it;
1736   pi_ctx.it_cls = pi_it_cls;
1737
1738   GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey, &peerinfo_it, &pi_ctx);
1739
1740   if (NULL != pi_it)
1741     pi_it (pi_it_cls, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, zero_bw, zero_bw);
1742
1743 }
1744
1745
1746 /* end of gnunet-service-ats_addresses.c */