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