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