src/ats/gnunet-service-ats_addresses.c

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