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  * Disassemble ATS information and update performance information in address
 374  *
 375  * Updates existing information and adds new information
 376  *
 377  * @param src source ATS information
 378  * @param ats_count number of ATS information
 379  * @param dest destination address
 380  * @return GNUNET_YES if address was address updated, GNUNET_NO otherwise
 381  */
 382 static unsigned int
 383 disassemble_ats_information (const struct GNUNET_ATS_Information *src,
 384                              uint32_t ats_count,
 385                              struct ATS_Address *dest)
 386 {
 387
 388   int c1;
 389   int c2;
 390   int found;
 391   int change;
 392
 393   struct GNUNET_ATS_Information add_atsi[ats_count];
 394   struct GNUNET_ATS_Information *tmp_atsi;
 395   uint32_t add_atsi_count;
 396
 397   change = GNUNET_NO;
 398   add_atsi_count = 0;
 399
 400   if (NULL == dest->atsi)
 401   {
 402                 dest->atsi = GNUNET_malloc (ats_count * sizeof (struct GNUNET_ATS_Information));
 403                 dest->atsi_count = ats_count;
 404                 memcpy (dest->atsi, src, ats_count * sizeof (struct GNUNET_ATS_Information));
 405                 return GNUNET_YES;
 406   }
 407
 408   /* Update existing performance information */
 409   for (c1 = 0; c1 < ats_count; c1++)
 410   {
 411         found = GNUNET_NO;
 412         for (c2 = 0; c2 < dest->atsi_count; c2++)
 413         {
 414                         if (src[c1].type == dest->atsi[c2].type)
 415                         {
 416                                 if (src[c1].value != dest->atsi[c2].value)
 417                                 {
 418                                                 dest->atsi[c2].value = src[c1].value;
 419                                                 change = GNUNET_YES;
 420                                 }
 421                                 found = GNUNET_YES;
 422                                 break;
 423                         }
 424         }
 425                 if (GNUNET_NO == found)
 426                 {
 427                                 add_atsi[add_atsi_count] = src[c1];
 428                                 add_atsi_count ++;
 429                 }
 430   }
 431
 432   if (add_atsi_count > 0)
 433   {
 434                 tmp_atsi = GNUNET_malloc ((dest->atsi_count + add_atsi_count) *
 435                                 sizeof (sizeof (struct GNUNET_ATS_Information)));
 436                 memcpy (tmp_atsi, dest->atsi, dest->atsi_count * sizeof (struct GNUNET_ATS_Information));
 437                 memcpy (&tmp_atsi[dest->atsi_count], add_atsi, add_atsi_count * sizeof (struct GNUNET_ATS_Information));
 438                         change = GNUNET_YES;
 439   }
 440
 441   return change;
 442 }
 443
 444 /**
 445  * Free the given address
 446  *
 447  * @param addr address to destroy
 448  */
 449 static void
 450 free_address (struct ATS_Address *addr)
 451 {
 452   GNUNET_free (addr->plugin);
 453   GNUNET_free_non_null (addr->atsi);
 454   GNUNET_free (addr);
 455 }
 456
 457 /**
 458  * Create a ATS_address with the given information
 459  *
 460  * @param peer peer
 461  * @param plugin_name plugin
 462  * @param plugin_addr address
 463  * @param plugin_addr_len address length
 464  * @param session_id session
 465  * @return the ATS_Address
 466  */
 467 static struct ATS_Address *
 468 create_address (const struct GNUNET_PeerIdentity *peer,
 469                 const char *plugin_name,
 470                 const void *plugin_addr, size_t plugin_addr_len,
 471                 uint32_t session_id)
 472 {
 473   struct ATS_Address *aa = NULL;
 474
 475   aa = GNUNET_malloc (sizeof (struct ATS_Address) + plugin_addr_len);
 476   aa->peer = *peer;
 477   aa->addr_len = plugin_addr_len;
 478   aa->addr = &aa[1];
 479   memcpy (&aa[1], plugin_addr, plugin_addr_len);
 480   aa->plugin = GNUNET_strdup (plugin_name);
 481   aa->session_id = session_id;
 482   aa->active = GNUNET_NO;
 483   aa->used = GNUNET_NO;
 484   aa->solver_information = NULL;
 485   aa->atsi = NULL;
 486   aa->atsi_count = 0;
 487   aa->assigned_bw_in = GNUNET_BANDWIDTH_value_init(0);
 488   aa->assigned_bw_out = GNUNET_BANDWIDTH_value_init(0);
 489   return aa;
 490 }
 491
 492
 493 /**
 494  * Destroy the given address.
 495  *
 496  * @param handle the address handle
 497  * @param addr address to destroy
 498  * @return GNUNET_YES if bandwidth allocations should be recalcualted
 499  */
 500 static int
 501 destroy_address (struct GAS_Addresses_Handle *handle, struct ATS_Address *addr)
 502 {
 503   int ret;
 504
 505   ret = GNUNET_NO;
 506   GNUNET_assert (GNUNET_YES ==
 507                  GNUNET_CONTAINER_multihashmap_remove (handle->addresses,
 508                                                        &addr->peer.hashPubKey,
 509                                                        addr));
 510   free_address (addr);
 511   return ret;
 512 }
 513
 514
 515 struct CompareAddressContext
 516 {
 517   const struct ATS_Address *search;
 518
 519   /* exact_address != NULL if address and session is equal */
 520   struct ATS_Address *exact_address;
 521   /* exact_address != NULL if address and session is 0 */
 522   struct ATS_Address *base_address;
 523 };
 524
 525 /**
 526  * Comapre addresses
 527  *
 528  * @param cls a CompareAddressContext containin the source address
 529  * @param key peer id
 530  * @param value the address to compare with
 531  * @return GNUNET_YES to continue, GNUNET_NO if address is founce
 532  */
 533
 534 static int
 535 compare_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
 536 {
 537   struct CompareAddressContext *cac = cls;
 538   struct ATS_Address *aa = value;
 539
 540   /* Find an matching exact address:
 541    *
 542    * Compare by:
 543    * aa->addr_len == cac->search->addr_len
 544    * aa->plugin == cac->search->plugin
 545    * aa->addr == cac->search->addr
 546    * aa->session == cac->search->session
 547    *
 548    * return as exact address
 549    */
 550   if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
 551   {
 552       if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == cac->search->session_id))
 553         cac->exact_address = aa;
 554   }
 555
 556   /* Find an matching base address:
 557    *
 558    * Properties:
 559    *
 560    * aa->session_id == 0
 561    *
 562    * Compare by:
 563    * aa->addr_len == cac->search->addr_len
 564    * aa->plugin == cac->search->plugin
 565    * aa->addr == cac->search->addr
 566    *
 567    * return as base address
 568    */
 569   if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
 570   {
 571       if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == 0))
 572         cac->base_address = aa;
 573   }
 574
 575   /* Find an matching exact address based on session:
 576    *
 577    * Properties:
 578    *
 579    * cac->search->addr_len == 0
 580    *
 581    * Compare by:
 582    * aa->plugin == cac->search->plugin
 583    * aa->session_id == cac->search->session_id
 584    *
 585    * return as exact address
 586    */
 587   if (0 == cac->search->addr_len)
 588   {
 589       if ((0 == strcmp (aa->plugin, cac->search->plugin)) && (aa->session_id == cac->search->session_id))
 590         cac->exact_address = aa;
 591   }
 592
 593   if (cac->exact_address == NULL)
 594     return GNUNET_YES; /* Continue iteration to find exact address */
 595   else
 596     return GNUNET_NO; /* Stop iteration since we have an exact address */
 597 }
 598
 599
 600 /**
 601  * Find an existing equivalent address record.
 602  * Compares by peer identity and network address OR by session ID
 603  * (one of the two must match).
 604  *
 605  * @param handle the address handle
 606  * @param peer peer to lookup addresses for
 607  * @param addr existing address record
 608  * @return existing address record, NULL for none
 609  */
 610 struct ATS_Address *
 611 find_equivalent_address (struct GAS_Addresses_Handle *handle,
 612                          const struct GNUNET_PeerIdentity *peer,
 613                          const struct ATS_Address *addr)
 614 {
 615   struct CompareAddressContext cac;
 616
 617   cac.exact_address = NULL;
 618   cac.base_address = NULL;
 619   cac.search = addr;
 620   GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
 621                                               &compare_address_it, &cac);
 622
 623   if (cac.exact_address == NULL)
 624     return cac.base_address;
 625   return cac.exact_address;
 626 }
 627
 628
 629 /**
 630  * Lookup an ATS address by the address properties and session or return an
 631  * equivalent address with a session == 0
 632  *
 633  * @param handle the address handle to use
 634  * @param peer peer
 635  * @param plugin_name transport plugin name
 636  * @param plugin_addr plugin address
 637  * @param plugin_addr_len length of the plugin address
 638  * @param session_id session id, can be 0
 639  * @param atsi performance information for this address
 640  * @param atsi_count number of performance information contained
 641  * @return an ATS_address or NULL
 642  */
 643
 644 static struct ATS_Address *
 645 lookup_address (struct GAS_Addresses_Handle *handle,
 646                 const struct GNUNET_PeerIdentity *peer,
 647                 const char *plugin_name,
 648                 const void *plugin_addr,
 649                 size_t plugin_addr_len,
 650                 uint32_t session_id,
 651                 const struct GNUNET_ATS_Information *atsi,
 652                 uint32_t atsi_count)
 653 {
 654   struct ATS_Address *aa;
 655   struct ATS_Address *ea;
 656
 657   aa = create_address (peer,
 658                        plugin_name,
 659                        plugin_addr, plugin_addr_len,
 660                        session_id);
 661
 662   /* Get existing address or address with session == 0 */
 663   ea = find_equivalent_address (handle, peer, aa);
 664   free_address (aa);
 665   if (ea == NULL)
 666   {
 667     return NULL;
 668   }
 669   else if (ea->session_id != session_id)
 670   {
 671     return NULL;
 672   }
 673   return ea;
 674 }
 675
 676
 677
 678 /**
 679  * Add a new address for a peer.
 680  *
 681  * @param handle the address handle to use
 682  * @param peer peer
 683  * @param plugin_name transport plugin name
 684  * @param plugin_addr plugin address
 685  * @param plugin_addr_len length of the plugin address
 686  * @param session_id session id, can be 0
 687  * @param atsi performance information for this address
 688  * @param atsi_count number of performance information contained
 689  */
 690 void
 691 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
 692                    const struct GNUNET_PeerIdentity *peer,
 693                    const char *plugin_name, const void *plugin_addr,
 694                    size_t plugin_addr_len, uint32_t session_id,
 695                    const struct GNUNET_ATS_Information *atsi,
 696                    uint32_t atsi_count)
 697 {
 698   struct ATS_Address *aa;
 699   struct ATS_Address *ea;
 700   unsigned int ats_res;
 701
 702   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 703               "Received `%s' for peer `%s'\n",
 704               "ADDRESS ADD",
 705               GNUNET_i2s (peer));
 706
 707   if (GNUNET_NO == handle->running)
 708     return;
 709
 710   GNUNET_assert (NULL != handle->addresses);
 711
 712   aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len,
 713                        session_id);
 714
 715   if (atsi_count != (ats_res = disassemble_ats_information(atsi, atsi_count, aa)))
 716   {
 717       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 718                 "While adding address: had %u ATS elements to add, could only add %u\n",
 719                 atsi_count, ats_res);
 720   }
 721
 722   /* Get existing address or address with session == 0 */
 723   ea = find_equivalent_address (handle, peer, aa);
 724   if (ea == NULL)
 725   {
 726     /* We have a new address */
 727     GNUNET_assert (GNUNET_OK ==
 728                    GNUNET_CONTAINER_multihashmap_put (handle->addresses,
 729                                                       &peer->hashPubKey, aa,
 730                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
 731     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Added new address for peer `%s' session id %u, %p\n",
 732                 GNUNET_i2s (peer), session_id, aa);
 733     /* Tell solver about new address */
 734     handle->s_add (handle->solver, handle->addresses, aa);
 735     /* Notify performance clients about new address */
 736     GAS_performance_notify_all_clients (&aa->peer,
 737         aa->plugin,
 738         aa->addr, aa->addr_len,
 739         aa->session_id,
 740         aa->atsi, aa->atsi_count,
 741         aa->assigned_bw_out,
 742         aa->assigned_bw_in);
 743     return;
 744   }
 745   GNUNET_free (aa->plugin);
 746   GNUNET_free (aa);
 747
 748   if (ea->session_id != 0)
 749   {
 750       /* This address with the same session is already existing
 751        * Should not happen */
 752       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 753                 "Added already existing address for peer `%s' `%s' %p with new session %u\n",
 754                 GNUNET_i2s (peer), plugin_name, session_id);
 755       GNUNET_break (0);
 756       return;
 757   }
 758
 759   /* We have an address without an session, update this address */
 760
 761   /* Notify solver about update with atsi information and session */
 762   handle->s_update (handle->solver, handle->addresses, ea, session_id, ea->used, atsi, atsi_count);
 763
 764   /* Do the update */
 765   ea->session_id = session_id;
 766   if (GNUNET_YES == disassemble_ats_information(atsi, atsi_count, ea))
 767   {
 768                 GAS_performance_notify_all_clients (&aa->peer,
 769                                 aa->plugin,
 770                                 aa->addr, aa->addr_len,
 771                                 aa->session_id,
 772                                 aa->atsi, aa->atsi_count,
 773                                 aa->assigned_bw_out,
 774                                 aa->assigned_bw_in);
 775   }
 776   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 777            "Updated existing address for peer `%s' %p with new session %u\n",
 778            GNUNET_i2s (peer), ea, session_id);
 779 }
 780
 781
 782 /**
 783  * Update an address with a session or performance information for a peer.
 784  *
 785  * If an address was added without a session it will be updated with the
 786  * session
 787  *
 788  * @param handle the address handle to use
 789  * @param peer peer
 790  * @param plugin_name transport plugin name
 791  * @param plugin_addr plugin address
 792  * @param plugin_addr_len length of the plugin address
 793  * @param session_id session id, can be 0
 794  * @param atsi performance information for this address
 795  * @param atsi_count number of performance information contained
 796  */
 797 void
 798 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
 799                       const struct GNUNET_PeerIdentity *peer,
 800                       const char *plugin_name, const void *plugin_addr,
 801                       size_t plugin_addr_len, uint32_t session_id,
 802                       const struct GNUNET_ATS_Information *atsi,
 803                       uint32_t atsi_count)
 804 {
 805   struct ATS_Address *aa;
 806
 807   if (GNUNET_NO == handle->running)
 808     return;
 809
 810   GNUNET_assert (NULL != handle->addresses);
 811
 812   /* Get existing address */
 813   aa = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
 814                        session_id, atsi, atsi_count);
 815   if (aa == NULL)
 816   {
 817     /* GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n", */
 818     /*             GNUNET_i2s (peer), plugin_name, session_id); */
 819     /* GNUNET_break (0); */
 820     return;
 821   }
 822
 823   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 824                 "Received `%s' for peer `%s' address \n",
 825                 "ADDRESS UPDATE",
 826                 GNUNET_i2s (peer), aa);
 827
 828   /* Tell solver about update */
 829   handle->s_update (handle->solver, handle->addresses, aa, session_id, aa->used, atsi, atsi_count);
 830
 831   /* Update address */
 832   if (GNUNET_YES == disassemble_ats_information (atsi, atsi_count, aa))
 833   {
 834                 /* Notify performance clients about updated address */
 835                 GAS_performance_notify_all_clients (&aa->peer,
 836                                 aa->plugin,
 837                                 aa->addr, aa->addr_len,
 838                                 aa->session_id,
 839                                 aa->atsi, aa->atsi_count,
 840                                 aa->assigned_bw_out,
 841                                 aa->assigned_bw_in);
 842   }
 843 }
 844
 845
 846 struct DestroyContext
 847 {
 848   struct ATS_Address *aa;
 849
 850   struct GAS_Addresses_Handle *handle;
 851
 852   /**
 853    * GNUNET_NO  : full address
 854    * GNUNET_YES : just session
 855    */
 856   int result;
 857 };
 858
 859
 860 /**
 861  * Delete an address
 862  *
 863  * If session != 0, just the session is deleted, the address itself still exists
 864  * If session == 0, remove full address
 865  * If session == 0 and addrlen == 0, destroy inbound address
 866  *
 867  * @param cls unused
 868  * @param key unused
 869  * @param value the 'struct ATS_Address'
 870  * @return GNUNET_OK (continue to iterate)
 871  */
 872 static int
 873 destroy_by_session_id (void *cls, const struct GNUNET_HashCode * key, void *value)
 874 {
 875   struct DestroyContext *dc = cls;
 876   struct GAS_Addresses_Handle *handle = dc->handle;
 877   const struct ATS_Address *des = dc->aa;
 878   struct ATS_Address *aa = value;
 879
 880   GNUNET_assert (0 == memcmp (&aa->peer, &des->peer,
 881                               sizeof (struct GNUNET_PeerIdentity)));
 882
 883
 884   if (des->session_id == 0)
 885   {
 886     /* Session == 0, remove full address  */
 887     if ((0 == strcmp (des->plugin, aa->plugin)) &&
 888         (aa->addr_len == des->addr_len) &&
 889         (0 == memcmp (des->addr, aa->addr, aa->addr_len)))
 890     {
 891
 892       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 893                   "Deleting full address for peer `%s' session %u %p\n",
 894                   GNUNET_i2s (&aa->peer), aa->session_id, aa);
 895
 896       /* Notify solver about deletion */
 897       handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
 898       destroy_address (handle, aa);
 899       dc->result = GNUNET_NO;
 900       return GNUNET_OK; /* Continue iteration */
 901     }
 902   }
 903   else
 904   {
 905     /* Session != 0, just remove session */
 906     if (aa->session_id != des->session_id)
 907       return GNUNET_OK; /* irrelevant */
 908
 909     if ((aa->session_id != 0) &&
 910         (0 != strcmp (des->plugin, aa->plugin)))
 911     {
 912         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 913                     "Different plugins during removal: `%s' vs `%s' \n",
 914                     des->plugin, aa->plugin);
 915         GNUNET_break (0);
 916         return GNUNET_OK;
 917     }
 918
 919     if (aa->addr_len == 0)
 920     {
 921         /* Inbound connection died, delete full address */
 922         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 923                     "Deleting inbound address for peer `%s': `%s' session %u\n",
 924                     GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
 925
 926         /* Notify solver about deletion */
 927         handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
 928         destroy_address (handle, aa);
 929         dc->result = GNUNET_NO;
 930         return GNUNET_OK; /* Continue iteration */
 931     }
 932     else
 933     {
 934         /* Session died */
 935         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 936                     "Deleting session for peer `%s': `%s' %u\n",
 937                     GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
 938         /* Notify solver to delete session */
 939         handle->s_del (handle->solver, handle->addresses, aa, GNUNET_YES);
 940         aa->session_id = 0;
 941         return GNUNET_OK;
 942     }
 943   }
 944   return GNUNET_OK;
 945 }
 946
 947
 948 /**
 949  * Remove an address or just a session for a peer.
 950  *
 951  * @param handle the address handle to use
 952  * @param peer peer
 953  * @param plugin_name transport plugin name
 954  * @param plugin_addr plugin address
 955  * @param plugin_addr_len length of the plugin address
 956  * @param session_id session id, can be 0
 957  */
 958 void
 959 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
 960                        const struct GNUNET_PeerIdentity *peer,
 961                        const char *plugin_name,
 962                        const void *plugin_addr,
 963                        size_t plugin_addr_len,
 964                        uint32_t session_id)
 965 {
 966   struct ATS_Address *ea;
 967   struct DestroyContext dc;
 968
 969   if (GNUNET_NO == handle->running)
 970     return;
 971
 972   /* Get existing address */
 973   ea = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
 974                        session_id, NULL, 0);
 975
 976   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 977               "Received `%s' for peer `%s' address %p session %u\n",
 978               "ADDRESS DESTROY",
 979               GNUNET_i2s (peer), ea, session_id);
 980
 981   if (ea == NULL)
 982   {
 983     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Tried to destroy unknown address for peer `%s' `%s' session id %u\n",
 984                 GNUNET_i2s (peer), plugin_name, session_id);
 985     return;
 986   }
 987
 988   GNUNET_break (0 < strlen (plugin_name));
 989   dc.handle = handle;
 990   dc.aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len, session_id);
 991
 992   GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
 993                                               &destroy_by_session_id, &dc);
 994   free_address (dc.aa);
 995 }
 996
 997
 998 /**
 999  * Notification about active use of an address.
1000  * in_use == GNUNET_YES:
1001  *      This address is used to maintain an active connection with a peer.
1002  * in_use == GNUNET_NO:
1003  *      This address is no longer used to maintain an active connection with a peer.
1004  *
1005  * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
1006  * before
1007  *
1008  * @param handle the address handle to use
1009  * @param peer peer
1010  * @param plugin_name transport plugin name
1011  * @param plugin_addr plugin address
1012  * @param plugin_addr_len length of the plugin address
1013  * @param session_id session id, can be 0
1014  * @param in_use GNUNET_YES if GNUNET_NO
1015  * @return GNUNET_SYSERR on failure (address unknown ...)
1016  */
1017 int
1018 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
1019                       const struct GNUNET_PeerIdentity *peer,
1020                       const char *plugin_name,
1021                       const void *plugin_addr,
1022                       size_t plugin_addr_len,
1023                       uint32_t session_id,
1024                       int in_use)
1025 {
1026   struct ATS_Address *ea;
1027
1028   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1029                 "Received `%s' for peer `%s'\n",
1030                 "ADDRESS IN USE",
1031                 GNUNET_i2s (peer));
1032
1033   if (GNUNET_NO == handle->running)
1034     return GNUNET_SYSERR;
1035
1036   ea = lookup_address (handle, peer, plugin_name,
1037                         plugin_addr, plugin_addr_len,
1038                         session_id, NULL, 0);
1039   if (NULL == ea)
1040   {
1041     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1042                 "Trying to set unknown address `%s', %s %u %s \n",
1043                 GNUNET_i2s (peer),
1044                 plugin_name, session_id,
1045                 (GNUNET_NO == in_use) ? "NO" : "YES");
1046     GNUNET_break (0);
1047     return GNUNET_SYSERR;
1048   }
1049   if (ea->used == in_use)
1050   {
1051     GNUNET_break (0);
1052     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1053                 "Address in use called multiple times for peer `%s': %s -> %s \n",
1054                 GNUNET_i2s (peer),
1055                 (GNUNET_NO == ea->used) ? "NO" : "YES",
1056                 (GNUNET_NO == in_use) ? "NO" : "YES");
1057     return GNUNET_SYSERR;
1058   }
1059
1060   /* Tell solver about update */
1061   handle->s_update (handle->solver, handle->addresses, ea, session_id, in_use, NULL, 0);
1062   ea->used = in_use;
1063
1064   return GNUNET_OK;
1065 }
1066
1067
1068 /**
1069  * Cancel address suggestions for a peer
1070  *
1071  * @param handle the address handle
1072  * @param peer the peer id
1073  */
1074 void
1075 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
1076                                       const struct GNUNET_PeerIdentity *peer)
1077 {
1078   struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1079
1080   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1081               "Received request: `%s' for peer %s\n", "request_address_cancel", GNUNET_i2s (peer));
1082
1083   while (NULL != cur)
1084   {
1085       if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1086         break; /* found */
1087       cur = cur->next;
1088   }
1089
1090   if (NULL == cur)
1091   {
1092       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1093                   "No address requests pending for peer `%s', cannot remove!\n", GNUNET_i2s (peer));
1094       return;
1095   }
1096   handle->s_get_stop (handle->solver, handle->addresses, peer);
1097   GAS_addresses_handle_backoff_reset (handle, peer);
1098   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1099               "Removed request pending for peer `%s\n", GNUNET_i2s (peer));
1100   GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1101   GNUNET_free (cur);
1102 }
1103
1104
1105 /**
1106  * Request address suggestions for a peer
1107  *
1108  * @param handle the address handle
1109  * @param peer the peer id
1110  */
1111 void
1112 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
1113                                const struct GNUNET_PeerIdentity *peer)
1114 {
1115   struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1116   struct ATS_Address *aa;
1117
1118   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1119               "Received `%s' for peer `%s'\n",
1120               "REQUEST ADDRESS",
1121               GNUNET_i2s (peer));
1122
1123   if (GNUNET_NO == handle->running)
1124     return;
1125   while (NULL != cur)
1126   {
1127       if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1128         break; /* already suggesting */
1129       cur = cur->next;
1130   }
1131   if (NULL == cur)
1132   {
1133       cur = GNUNET_malloc (sizeof (struct GAS_Addresses_Suggestion_Requests));
1134       cur->id = (*peer);
1135       GNUNET_CONTAINER_DLL_insert (handle->r_head, handle->r_tail, cur);
1136   }
1137
1138   /* Get prefered address from solver */
1139   aa = (struct ATS_Address *) handle->s_get (handle->solver, handle->addresses, peer);
1140   if (NULL == aa)
1141   {
1142     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1143                 "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
1144     return;
1145   }
1146
1147   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1148               "Suggesting address %p for peer `%s'\n", aa, GNUNET_i2s (peer));
1149
1150   GAS_scheduling_transmit_address_suggestion (peer,
1151                                               aa->plugin,
1152                                               aa->addr, aa->addr_len,
1153                                               aa->session_id,
1154                                               aa->atsi, aa->atsi_count,
1155                                               aa->assigned_bw_out,
1156                                               aa->assigned_bw_in);
1157
1158   aa->block_interval = GNUNET_TIME_relative_add (aa->block_interval, ATS_BLOCKING_DELTA);
1159   aa->blocked_until = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(), aa->block_interval);
1160
1161   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1162        "Address %p ready for suggestion, block interval now %llu \n",
1163        aa, aa->block_interval);
1164 }
1165
1166
1167 /**
1168  * Iterator to reset address blocking
1169  *
1170  * @param cls not used
1171  * @param key the peer
1172  * @param value the address to reset
1173  * @return GNUNET_OK to continue
1174  */
1175 static int
1176 reset_address_it (void *cls, const struct GNUNET_HashCode *key, void *value)
1177 {
1178   struct ATS_Address *aa = value;
1179
1180   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1181               "Resetting interval for peer `%s' address %p from %llu to 0\n",
1182               GNUNET_i2s (&aa->peer), aa, aa->block_interval);
1183
1184   aa->blocked_until = GNUNET_TIME_UNIT_ZERO_ABS;
1185   aa->block_interval = GNUNET_TIME_UNIT_ZERO;
1186   return GNUNET_OK;
1187 }
1188
1189
1190 /**
1191  * Reset suggestion backoff for a peer
1192  *
1193  * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
1194  * reset using this function
1195  *
1196  * @param handle the address handle
1197  * @param peer the peer id
1198  */
1199 void
1200 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
1201                                     const struct GNUNET_PeerIdentity *peer)
1202 {
1203   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1204               "Received `%s' for peer `%s'\n",
1205               "RESET BACKOFF",
1206               GNUNET_i2s (peer));
1207
1208   GNUNET_break (GNUNET_SYSERR != GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses,
1209                                               &peer->hashPubKey,
1210                                               &reset_address_it,
1211                                               NULL));
1212 }
1213
1214
1215 /**
1216  * Change the preference for a peer
1217  *
1218  * @param handle the address handle
1219  * @param client the client sending this request
1220  * @param peer the peer id
1221  * @param kind the preference kind to change
1222  * @param score the new preference score
1223  */
1224 void
1225 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
1226                                  void *client,
1227                                  const struct GNUNET_PeerIdentity *peer,
1228                                  enum GNUNET_ATS_PreferenceKind kind,
1229                                  float score)
1230 {
1231   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1232               "Received `%s' for peer `%s' for client %p\n",
1233               "CHANGE PREFERENCE",
1234               GNUNET_i2s (peer), client);
1235
1236   if (GNUNET_NO == handle->running)
1237     return;
1238
1239   if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains (handle->addresses,
1240                                                           &peer->hashPubKey))
1241   {
1242       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1243                   "Received `%s' for unknown peer `%s' from client %p\n",
1244                   "CHANGE PREFERENCE",
1245                   GNUNET_i2s (peer), client);
1246       return;
1247   }
1248
1249   /* Tell solver about update */
1250   handle->s_pref (handle->solver, client, peer, kind, score);
1251 }
1252
1253
1254 /**
1255  * Load quotas for networks from configuration
1256  *
1257  * @param cfg configuration handle
1258  * @param out_dest where to write outbound quotas
1259  * @param in_dest where to write inbound quotas
1260  * @param dest_length length of inbound and outbound arrays
1261  * @return number of networks loaded
1262  */
1263 static unsigned int
1264 load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned long long *out_dest, unsigned long long *in_dest, int dest_length)
1265 {
1266   char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1267   char * entry_in = NULL;
1268   char * entry_out = NULL;
1269   char * quota_out_str;
1270   char * quota_in_str;
1271   int c;
1272   int res;
1273
1274   for (c = 0; (c < GNUNET_ATS_NetworkTypeCount) && (c < dest_length); c++)
1275   {
1276     in_dest[c] = 0;
1277     out_dest[c] = 0;
1278     GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
1279     GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
1280
1281     /* quota out */
1282     if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_out, &quota_out_str))
1283     {
1284       res = GNUNET_NO;
1285       if (0 == strcmp(quota_out_str, GNUNET_ATS_MaxBandwidthString))
1286       {
1287         out_dest[c] = GNUNET_ATS_MaxBandwidth;
1288         res = GNUNET_YES;
1289       }
1290       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, &out_dest[c])))
1291         res = GNUNET_YES;
1292       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_out,  &out_dest[c])))
1293          res = GNUNET_YES;
1294
1295       if (GNUNET_NO == res)
1296       {
1297           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s':  `%s', assigning default bandwidth %llu\n"),
1298               network_str[c], quota_out_str, GNUNET_ATS_DefaultBandwidth);
1299           out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1300       }
1301       else
1302       {
1303           GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Outbound quota configure for network `%s' is %llu\n"),
1304               network_str[c], out_dest[c]);
1305       }
1306       GNUNET_free (quota_out_str);
1307     }
1308     else
1309     {
1310       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configured for network `%s', assigning default bandwidth %llu\n"),
1311           network_str[c], GNUNET_ATS_DefaultBandwidth);
1312       out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1313     }
1314
1315     /* quota in */
1316     if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_in, &quota_in_str))
1317     {
1318       res = GNUNET_NO;
1319       if (0 == strcmp(quota_in_str, GNUNET_ATS_MaxBandwidthString))
1320       {
1321         in_dest[c] = GNUNET_ATS_MaxBandwidth;
1322         res = GNUNET_YES;
1323       }
1324       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, &in_dest[c])))
1325         res = GNUNET_YES;
1326       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_in,  &in_dest[c])))
1327          res = GNUNET_YES;
1328
1329       if (GNUNET_NO == res)
1330       {
1331           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s':  `%s', assigning default bandwidth %llu\n"),
1332               network_str[c], quota_in_str, GNUNET_ATS_DefaultBandwidth);
1333           in_dest[c] = GNUNET_ATS_DefaultBandwidth;
1334       }
1335       else
1336       {
1337           GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Inbound quota configured for network `%s' is %llu\n"),
1338               network_str[c], in_dest[c]);
1339       }
1340       GNUNET_free (quota_in_str);
1341     }
1342     else
1343     {
1344       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configure for network `%s', assigning default bandwidth %llu\n"),
1345           network_str[c], GNUNET_ATS_DefaultBandwidth);
1346       out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1347     }
1348     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]);
1349     GNUNET_free (entry_out);
1350     GNUNET_free (entry_in);
1351   }
1352   return GNUNET_ATS_NetworkTypeCount;
1353 }
1354
1355
1356 /**
1357  * Callback for solver to notify about assignment changes
1358  *
1359  * @param cls the GAS_Addresses_Handle
1360  * @param address the address with changes
1361  */
1362 static void
1363 bandwidth_changed_cb (void *cls, struct ATS_Address *address)
1364 {
1365   struct GAS_Addresses_Handle *handle = cls;
1366   struct GAS_Addresses_Suggestion_Requests *cur;
1367
1368   GNUNET_assert (handle != NULL);
1369   GNUNET_assert (address != NULL);
1370
1371   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Bandwidth assignment changed for peer %s \n", GNUNET_i2s(&address->peer));
1372
1373   /* Notify performance clients about changes to address */
1374   GAS_performance_notify_all_clients (&address->peer,
1375       address->plugin,
1376       address->addr, address->addr_len,
1377       address->session_id,
1378       address->atsi, address->atsi_count,
1379       address->assigned_bw_out,
1380       address->assigned_bw_in);
1381   cur = handle->r_head;
1382   while (NULL != cur)
1383   {
1384       if (0 == memcmp (&address->peer, &cur->id, sizeof (cur->id)))
1385         break; /* we have an address request pending*/
1386       cur = cur->next;
1387   }
1388   if (NULL == cur)
1389   {
1390       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1391                   "Nobody is interested in peer `%s' :(\n",GNUNET_i2s (&address->peer));
1392       return;
1393   }
1394
1395   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1396               "Sending bandwidth update for peer `%s'\n",GNUNET_i2s (&address->peer));
1397
1398   /* *Notify scheduling clients about suggestion */
1399   GAS_scheduling_transmit_address_suggestion (&address->peer,
1400                                               address->plugin,
1401                                               address->addr, address->addr_len,
1402                                               address->session_id,
1403                                               address->atsi, address->atsi_count,
1404                                               address->assigned_bw_out,
1405                                               address->assigned_bw_in);
1406 }
1407
1408
1409 /**
1410  * Initialize address subsystem. The addresses subsystem manages the addresses
1411  * known and current performance information. It has a solver component
1412  * responsible for the resource allocation. It tells the solver about changes
1413  * and receives updates when the solver changes the ressource allocation.
1414  *
1415  * @param cfg configuration to use
1416  * @param stats the statistics handle to use
1417  * @return an address handle
1418  */
1419 struct GAS_Addresses_Handle *
1420 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1421                     const struct GNUNET_STATISTICS_Handle *stats)
1422 {
1423   struct GAS_Addresses_Handle *ah;
1424   int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1425   unsigned long long  quotas_in[GNUNET_ATS_NetworkTypeCount];
1426   unsigned long long  quotas_out[GNUNET_ATS_NetworkTypeCount];
1427   int quota_count;
1428   char *mode_str;
1429   int c;
1430
1431   ah = GNUNET_malloc (sizeof (struct GAS_Addresses_Handle));
1432   ah->running = GNUNET_NO;
1433
1434   ah->stat = (struct GNUNET_STATISTICS_Handle *) stats;
1435   /* Initialize the addresses database */
1436   ah->addresses = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
1437   GNUNET_assert (NULL != ah->addresses);
1438
1439   /* Figure out configured solution method */
1440   if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", "MODE", &mode_str))
1441   {
1442       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "No ressource assignment method configured, using simplistic approch\n");
1443       ah->ats_mode = MODE_SIMPLISTIC;
1444   }
1445   else
1446   {
1447       for (c = 0; c < strlen (mode_str); c++)
1448         mode_str[c] = toupper (mode_str[c]);
1449       if (0 == strcmp (mode_str, "SIMPLISTIC"))
1450       {
1451           ah->ats_mode = MODE_SIMPLISTIC;
1452       }
1453       else if (0 == strcmp (mode_str, "MLP"))
1454       {
1455           ah->ats_mode = MODE_MLP;
1456 #if !HAVE_LIBGLPK
1457           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Assignment method `%s' configured, but GLPK is not availabe, please install \n", mode_str);
1458           ah->ats_mode = MODE_SIMPLISTIC;
1459 #endif
1460       }
1461       else
1462       {
1463           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Invalid ressource assignment method `%s' configured, using simplistic approch\n", mode_str);
1464           ah->ats_mode = MODE_SIMPLISTIC;
1465       }
1466       GNUNET_free (mode_str);
1467   }
1468   /* Start configured solution method */
1469   switch (ah->ats_mode)
1470   {
1471     case MODE_MLP:
1472       /* Init the MLP solver with default values */
1473 #if HAVE_LIBGLPK
1474       ah->ats_mode = MODE_MLP;
1475       ah->s_init = &GAS_mlp_init;
1476       ah->s_add = &GAS_mlp_address_add;
1477       ah->s_update = &GAS_mlp_address_update;
1478       ah->s_get = &GAS_mlp_get_preferred_address;
1479       ah->s_get_stop = &GAS_mlp_stop_get_preferred_address;
1480       ah->s_pref = &GAS_mlp_address_change_preference;
1481       ah->s_del =  &GAS_mlp_address_delete;
1482       ah->s_done = &GAS_mlp_done;
1483 #else
1484       GNUNET_free (ah);
1485       return NULL;
1486 #endif
1487       break;
1488     case MODE_SIMPLISTIC:
1489       /* Init the simplistic solver with default values */
1490       ah->ats_mode = MODE_SIMPLISTIC;
1491       ah->s_init = &GAS_simplistic_init;
1492       ah->s_add = &GAS_simplistic_address_add;
1493       ah->s_update = &GAS_simplistic_address_update;
1494       ah->s_get = &GAS_simplistic_get_preferred_address;
1495       ah->s_get_stop = &GAS_simplistic_stop_get_preferred_address;
1496       ah->s_pref = &GAS_simplistic_address_change_preference;
1497       ah->s_del  = &GAS_simplistic_address_delete;
1498       ah->s_done = &GAS_simplistic_done;
1499       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ATS started in %s mode\n", "SIMPLISTIC");
1500       break;
1501     default:
1502       return NULL;
1503       break;
1504   }
1505
1506   GNUNET_assert (NULL != ah->s_init);
1507   GNUNET_assert (NULL != ah->s_add);
1508   GNUNET_assert (NULL != ah->s_update);
1509   GNUNET_assert (NULL != ah->s_get);
1510   GNUNET_assert (NULL != ah->s_get_stop);
1511   GNUNET_assert (NULL != ah->s_pref);
1512   GNUNET_assert (NULL != ah->s_del);
1513   GNUNET_assert (NULL != ah->s_done);
1514
1515   quota_count = load_quotas(cfg, quotas_in, quotas_out, GNUNET_ATS_NetworkTypeCount);
1516
1517   ah->solver = ah->s_init (cfg, stats, quotas, quotas_in, quotas_out, quota_count, &bandwidth_changed_cb, ah);
1518   if (NULL == ah->solver)
1519   {
1520     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Failed to initialize solver!\n");
1521     GNUNET_free (ah);
1522     return NULL;
1523   }
1524
1525   /* up and running */
1526   ah->running = GNUNET_YES;
1527   return ah;
1528 }
1529
1530
1531 /**
1532  * Free memory of address.
1533  *
1534  * @param cls NULL
1535  * @param key peer identity (unused)
1536  * @param value the 'struct ATS_Address' to free
1537  * @return GNUNET_OK (continue to iterate)
1538  */
1539 static int
1540 free_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1541 {
1542   struct GAS_Addresses_Handle *handle = cls;
1543   struct ATS_Address *aa = value;
1544   handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
1545   destroy_address (handle, aa);
1546   return GNUNET_OK;
1547 }
1548
1549
1550 /**
1551  * Remove all addresses
1552  *
1553  * @param handle the address handle to use
1554  */
1555 void
1556 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle)
1557 {
1558   if (GNUNET_NO == handle->running)
1559     return;
1560
1561   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1562               "Received `%s'\n",
1563               "DESTROY ALL");
1564
1565   if (handle->addresses != NULL)
1566     GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &free_address_it, handle);
1567 }
1568
1569
1570 /**
1571  * Shutdown address subsystem.
1572  *
1573  * @param handle the address handle to shutdown
1574  */
1575 void
1576 GAS_addresses_done (struct GAS_Addresses_Handle *handle)
1577 {
1578   struct GAS_Addresses_Suggestion_Requests *cur;
1579
1580   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1581               "Shutting down addresses\n");
1582   GNUNET_assert (NULL != handle);
1583   GAS_addresses_destroy_all (handle);
1584   handle->running = GNUNET_NO;
1585   GNUNET_CONTAINER_multihashmap_destroy (handle->addresses);
1586   handle->addresses = NULL;
1587   while (NULL != (cur = handle->r_head))
1588   {
1589       GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1590       GNUNET_free (cur);
1591   }
1592   handle->s_done (handle->solver);
1593   GNUNET_free (handle);
1594   /* Stop configured solution method */
1595
1596 }
1597
1598
1599 struct PeerIteratorContext
1600 {
1601   GNUNET_ATS_Peer_Iterator it;
1602   void *it_cls;
1603   struct GNUNET_CONTAINER_MultiHashMap *peers_returned;
1604 };
1605
1606
1607 /**
1608  * Iterator to iterate over all peers
1609  *
1610  * @param cls a PeerIteratorContext
1611  * @param key the peer id
1612  * @param value the ATS_address
1613  * @return GNUNET_OK to continue
1614  */
1615 static int
1616 peer_it (void *cls,
1617          const struct GNUNET_HashCode * key,
1618          void *value)
1619 {
1620   struct PeerIteratorContext *ip_ctx = cls;
1621   struct GNUNET_PeerIdentity tmp;
1622
1623   if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(ip_ctx->peers_returned, key))
1624   {
1625       GNUNET_CONTAINER_multihashmap_put(ip_ctx->peers_returned, key, NULL, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1626       tmp.hashPubKey = (*key);
1627       ip_ctx->it (ip_ctx->it_cls, &tmp);
1628   }
1629
1630   return GNUNET_OK;
1631 }
1632
1633
1634 /**
1635  * Return information all peers currently known to ATS
1636  *
1637  * @param handle the address handle to use
1638  * @param p_it the iterator to call for every peer
1639  * @param p_it_cls the closure for the iterator
1640  */
1641 void
1642 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
1643                                                                                                                  GNUNET_ATS_Peer_Iterator p_it,
1644                                                                                                                  void *p_it_cls)
1645 {
1646   struct PeerIteratorContext ip_ctx;
1647   unsigned int size;
1648
1649   if (NULL == p_it)
1650       return;
1651   GNUNET_assert (NULL != handle->addresses);
1652
1653   size = GNUNET_CONTAINER_multihashmap_size(handle->addresses);
1654   if (0 != size)
1655   {
1656     ip_ctx.it = p_it;
1657     ip_ctx.it_cls = p_it_cls;
1658     ip_ctx.peers_returned = GNUNET_CONTAINER_multihashmap_create (size, GNUNET_NO);
1659     GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &peer_it, &ip_ctx);
1660     GNUNET_CONTAINER_multihashmap_destroy (ip_ctx.peers_returned);
1661   }
1662   p_it (p_it_cls, NULL);
1663 }
1664
1665
1666 struct PeerInfoIteratorContext
1667 {
1668   GNUNET_ATS_PeerInfo_Iterator it;
1669   void *it_cls;
1670 };
1671
1672
1673 /**
1674  * Iterator to iterate over a peer's addresses
1675  *
1676  * @param cls a PeerInfoIteratorContext
1677  * @param key the peer id
1678  * @param value the ATS_address
1679  * @return GNUNET_OK to continue
1680  */
1681 static int
1682 peerinfo_it (void *cls,
1683              const struct GNUNET_HashCode * key,
1684              void *value)
1685 {
1686   struct PeerInfoIteratorContext *pi_ctx = cls;
1687   struct ATS_Address *addr = (struct ATS_Address *)  value;
1688
1689   if (NULL != pi_ctx->it)
1690   {
1691     pi_ctx->it (pi_ctx->it_cls,
1692                 &addr->peer,
1693                 addr->plugin,
1694                 addr->addr, addr->addr_len,
1695                 addr->active,
1696                 addr->atsi, addr->atsi_count,
1697                 addr->assigned_bw_out,
1698                 addr->assigned_bw_in);
1699   }
1700   return GNUNET_YES;
1701 }
1702
1703
1704 /**
1705  * Return information all peers currently known to ATS
1706  *
1707  * @param handle the address handle to use
1708  * @param peer the respective peer
1709  * @param pi_it the iterator to call for every peer
1710  * @param pi_it_cls the closure for the iterator
1711  */
1712 void
1713 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
1714                              const struct GNUNET_PeerIdentity *peer,
1715                              GNUNET_ATS_PeerInfo_Iterator pi_it,
1716                              void *pi_it_cls)
1717 {
1718   struct PeerInfoIteratorContext pi_ctx;
1719   struct GNUNET_BANDWIDTH_Value32NBO zero_bw;
1720   GNUNET_assert (NULL != peer);
1721   GNUNET_assert (NULL != handle->addresses);
1722   if (NULL == pi_it)
1723     return; /* does not make sense without callback */
1724
1725   zero_bw = GNUNET_BANDWIDTH_value_init (0);
1726   pi_ctx.it = pi_it;
1727   pi_ctx.it_cls = pi_it_cls;
1728
1729   GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey, &peerinfo_it, &pi_ctx);
1730
1731   if (NULL != pi_it)
1732     pi_it (pi_it_cls, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, zero_bw, zero_bw);
1733
1734 }
1735
1736
1737 /* end of gnunet-service-ats_addresses.c */