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_ats_plugin.h"
  30 #include "gnunet-service-ats.h"
  31 #include "gnunet-service-ats_addresses.h"
  32 #include "gnunet-service-ats_normalization.h"
  33 #include "gnunet-service-ats_performance.h"
  34 #include "gnunet-service-ats_scheduling.h"
  35 #include "gnunet-service-ats_reservations.h"
  36
  37
  38 /**
  39  * NOTE: Do not change this documentation. This documentation is based on
  40  * gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
  41  * use build_txt.sh to generate plaintext output
  42  *
  43  *   1 ATS addresses : ATS address management
  44  *
  45  *    This ATS addresses ("addresses") component manages the addresses known to
  46  *    ATS service and suggests addresses to transport service when it is
  47  *    interested in address suggestion for a peer. ATS addresses also
  48  *    instantiates the bandwidth assignment mechanism (solver), notifies it
  49  *    about changes to addresses and forwards changes to bandwidth assignments
  50  *    to transport, depending if transport is interested in this change.
  51  *
  52  *     1.1 Input data
  53  *
  54  *       1.1.1 Addresses
  55  *
  56  *    Addresses are added by specifying peer ID, plugin, address, address length
  57  *    and session, if available. ATS information can be specified if available.
  58  *
  59  *       1.1.2 Networks
  60  *
  61  *    ATS specifies a fix set of networks an address can belong to. For each
  62  *    network an inbound and outbound quota will be specified. The available
  63  *    networks and addtional helper varaibles are defined in
  64  *    gnunet_ats_service.h. At the moment 5 networks are defined:
  65  *      * GNUNET_ATS_NET_UNSPECIFIED
  66  *      * GNUNET_ATS_NET_LOOPBACK
  67  *      * GNUNET_ATS_NET_LAN
  68  *      * GNUNET_ATS_NET_WAN
  69  *      * GNUNET_ATS_NET_WLAN
  70  *
  71  *    The total number of networks defined is stored in
  72  *    GNUNET_ATS_NetworkTypeCount GNUNET_ATS_NetworkType can be used array
  73  *    initializer for an int array, while GNUNET_ATS_NetworkType is an
  74  *    initializer for a char array containing a string description of all
  75  *    networks
  76  *
  77  *       1.1.3 Quotas
  78  *
  79  *    An inbound and outbound quota for each of the networks mentioned in 1.1.2
  80  *    is loaded from ats configuration during initialization. This quota defines
  81  *    to total amount of inbound and outbound traffic allowed for a specific
  82  *    network. The configuration values used are in section ats:
  83  *      * "NETWORK"_QUOTA_IN = <value>
  84  *      * "NETWORK"_QUOTA_IN = <value>
  85  *
  86  *    You can specify quotas by setting the <value> to a:
  87  *      * unrestricted: unlimited
  88  *      * number of bytes: e.g. 10240
  89  *      * fancy value: e.g. 64 Kib
  90  *
  91  *    unlimited is defined as GNUNET_ATS_MaxBandwidthString and equivalent to
  92  *    the value GNUNET_ATS_MaxBandwidth Important predefined values for quotas
  93  *    are:
  94  *      * GNUNET_ATS_DefaultBandwidth: 65536
  95  *      * GNUNET_ATS_MaxBandwidth: UINT32_MAX
  96  *      * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT: 1024
  97  *
  98  *    Details of loading quotas and default values will be described on
  99  *
 100  *       1.1.4 Preference values
 101  *
 102  *     1.2 Data structures used
 103  *
 104  *    Addresse uses struct ATS_Address for each address. The structs are stored
 105  *    in a linked list and provides a pointer void *solver_information for the
 106  *    solver to store address specific information. It provides the int values
 107  *    active which is set to GNUNET_YES if the address is select for transport
 108  *    use and used, representing that transport service is actively using this
 109  *    address. Address information are stored in peer, addr, addr_len, plugin.
 110  *
 111  *     1.3 Initialization
 112  *
 113  *    During initialization a hashmap to store addresses is created. The quotas
 114  *    for all networks defined for ATS are loaded from configuration. For each
 115  *    network first the logic will check if the string
 116  *    GNUNET_ATS_MaxBandwidthString is configured, if not it will try to convert
 117  *    the configured value as a fancy size and if this fails it will try to use
 118  *    it as a value_number. If no configuration value is found it will assign
 119  *    GNUNET_ATS_DefaultBandwidth. The most important step is to load the
 120  *    configured solver using configuration "[ats]:MODE". Current solvers are
 121  *    MODE_PROPORTIONAL, MODE_MLP. Interaction is done using a solver API
 122  *
 123  *     1.4 Solver API
 124  *
 125  *    Solver functions:
 126  *      * s_init: init the solver with required information
 127  *      * s_add: add a new address
 128  *      * s_update: update ATS values or session for an address
 129  *      * s_get: get prefered address for a peer
 130  *      * s_del: delete an address
 131  *      * s_pref: change preference value for a peer
 132  *      * s_done: shutdown solver
 133  *
 134  *    Callbacks: addresses provides a bandwidth_changed_cb callback to the
 135  *    solver which is called when bandwidth assigned to peer has changed
 136  *
 137  *     1.5 Shutdown
 138  *
 139  *    During shutdown all addresses are freed and the solver told to shutdown
 140  *
 141  *     1.6 Addresses and sessions
 142  *
 143  *    Addresses consist of the address itself and a numerical session. When a
 144  *    new address without a session is added it has no session, so it gets
 145  *    session 0 assigned. When an address with a session is added and an address
 146  *    object with session 0 is found, this object is updated with the session
 147  *    otherwise a new address object with this session assigned is created.
 148  *
 149  *       1.6.1 Terminology
 150  *
 151  *    Addresses a1,a2 with session s1, s2 are "exact" if:
 152  *    (a1 == a2)&&(s1 == s2)
 153  *    Addresses a1,a2 with session s1, s2 are "equivalent" if:
 154  *    (a1 == a2)&&((s1 == s2)||(s1 == 0)||(s2 == 0)
 155  *
 156  *     1.7 Address management
 157  *
 158  *    Transport service notifies ATS about changes to the addresses known to
 159  *    him.
 160  *
 161  *       1.7.1 Adding an address
 162  *
 163  *    When transport learns a new address it tells ATS and ATS is telling
 164  *    addresses about it using GAS_address_add. If not known to addresses it
 165  *    creates a new address object and calls solver's s_add. ATS information are
 166  *    deserialized and solver is notified about the session and ATS information
 167  *    using s_update.
 168  *
 169  *       1.7.2 Updating an address
 170  *
 171  *    Addresses does an lookup up for the existing address with the given
 172  *    session. If disassembles included ATS information and notifies the solver
 173  *    using s_update about the update.
 174  *
 175  *       1.7.3 Deleting an address
 176  *
 177  *    Addresses does an lookup for the exact address and session and if removes
 178  *    this address. If session != 0 the session is set to 0 and the address is
 179  *    kept. If session == 0, the addresses is removed.
 180  *
 181  *       1.7.4 Requesting an address suggestion
 182  *
 183  *    The address client issues a request address message to be notified about
 184  *    address suggestions for a specific peer. Addresses asks the solver with
 185  *    s_get. If no address is available, it will not send a response, otherwise
 186  *    it will respond with the choosen address.
 187  *
 188  *       1.7.5 Address suggestions
 189  *
 190  *    Addresses will notify the client automatically on any bandwidth_changed_cb
 191  *    by the solver if a address suggestion request is pending. If no address is
 192  *    available it will not respond at all If the client is not interested
 193  *    anymore, it has to cancel the address suggestion request.
 194  *
 195  *       1.7.6 Suggestions blocks and reset
 196  *
 197  *    After suggesting an address it is blocked for ATS_BLOCKING_DELTA sec. to
 198  *    prevent the client from being thrashed. If the client requires immediately
 199  *    it can reset this block using GAS_addresses_handle_backoff_reset.
 200  *
 201  *       1.7.7 Marking address in use
 202  *
 203  *    The client can notify addresses that it successfully uses an address and
 204  *    wants this address to be kept by calling GSA_address_in_use. Adresses will
 205  *    mark the address as used an notify the solver about the use.
 206  *
 207  *       1.7.8 Address lifecycle
 208  *
 209  *      * (add address)
 210  *      * (updated address) || (address in use)
 211  *      * (delete address)
 212  *
 213  *     1.8 Bandwidth assignment
 214  *
 215  *    The addresses are used to perform resource allocation operations. ATS
 216  *    addresses takes care of instantiating the solver configured and notifies
 217  *    the respective solver about address changes and receives changes to the
 218  *    bandwidth assignment from the solver. The current bandwidth assignment is
 219  *    sent to transport. The specific solvers will be described in the specific
 220  *    section.
 221  *
 222  *     1.9 Changing peer preferences
 223  *
 224  *    The bandwidth assigned to a peer can be influenced by setting a preference
 225  *    for a peer. The prefernce will be given to to the solver with s_pref which
 226  *    has to take care of the preference value
 227
 228  */
 229
 230
 231 /**
 232  * Pending Address suggestion requests
 233  */
 234 struct GAS_Addresses_Suggestion_Requests
 235 {
 236   /**
 237    * Next in DLL
 238    */
 239   struct GAS_Addresses_Suggestion_Requests *next;
 240
 241   /**
 242    * Previous in DLL
 243    */
 244   struct GAS_Addresses_Suggestion_Requests *prev;
 245
 246   /**
 247    * Peer ID
 248    */
 249   struct GNUNET_PeerIdentity id;
 250 };
 251
 252  /**
 253   * Pending Address suggestion requests
 254   */
 255  struct GAS_Addresses_Preference_Clients
 256  {
 257    /**
 258     * Next in DLL
 259     */
 260    struct GAS_Addresses_Preference_Clients *next;
 261
 262    /**
 263     * Previous in DLL
 264     */
 265    struct GAS_Addresses_Preference_Clients *prev;
 266
 267    /**
 268     * Peer ID
 269     */
 270    void *client;
 271  };
 272
 273 /**
 274  * Handle for ATS address component
 275  */
 276 struct GAS_Addresses_Handle
 277 {
 278   /**
 279    *
 280    */
 281   struct GNUNET_STATISTICS_Handle *stat;
 282
 283   /**
 284    * A multihashmap to store all addresses
 285    */
 286   struct GNUNET_CONTAINER_MultiPeerMap *addresses;
 287
 288   /**
 289    * Is ATS addresses running
 290    */
 291   int running;
 292
 293   /**
 294    * Preferences clients
 295    */
 296   int pref_clients;
 297
 298   /**
 299    * Configured ATS solver
 300    */
 301   int ats_mode;
 302
 303   /**
 304    *  Solver handle
 305    */
 306   void *solver;
 307
 308   /**
 309    * Address suggestion requests DLL head
 310    */
 311   struct GAS_Addresses_Suggestion_Requests *pending_requests_head;
 312
 313   /**
 314    * Address suggestion requests DLL tail
 315    */
 316   struct GAS_Addresses_Suggestion_Requests *pending_requests_tail;
 317
 318   /**
 319    * Address suggestion requests DLL head
 320    */
 321   struct GAS_Addresses_Preference_Clients *preference_clients_head;
 322
 323   /**
 324    * Address suggestion requests DLL head
 325    */
 326   struct GAS_Addresses_Preference_Clients *preference_clients_tail;
 327
 328   /**
 329    * Solver functions
 330    */
 331   struct GNUNET_ATS_PluginEnvironment env;
 332
 333   /**
 334    * Solver plugin name as string
 335    */
 336   char *plugin;
 337 };
 338
 339 /**
 340  * Disassemble ATS information and update performance information in address
 341  *
 342  * Updates existing information and adds new information
 343  *
 344  * @param dest destination address
 345  * @param update source ATS information
 346  * @param update_count number of ATS information
 347  * @param delta_dest ats performance information which were updated
 348  *                              including previous value
 349  * @param delta_count number of ATS information in the delta
 350  * @return GNUNET_YES if address was address updated, GNUNET_NO otherwise
 351  */
 352 static unsigned int
 353 disassemble_ats_information (struct ATS_Address *dest,
 354     const struct GNUNET_ATS_Information *update, uint32_t update_count,
 355     struct GNUNET_ATS_Information **delta_dest, uint32_t *delta_count)
 356 {
 357
 358   int c1;
 359   int c2;
 360   int found;
 361   int change;
 362
 363   struct GNUNET_ATS_Information add_atsi[update_count];
 364   struct GNUNET_ATS_Information delta_atsi[update_count];
 365   struct GNUNET_ATS_Information *tmp_atsi;
 366   uint32_t add_atsi_count;
 367   uint32_t delta_atsi_count;
 368
 369   change = GNUNET_NO;
 370   add_atsi_count = 0;
 371   delta_atsi_count = 0;
 372
 373   if (0 == update_count)
 374     return GNUNET_NO;
 375
 376   if (NULL == dest->atsi)
 377   {
 378     /* Create performance information */
 379     dest->atsi =
 380         GNUNET_malloc (update_count * sizeof (struct GNUNET_ATS_Information));
 381     dest->atsi_count = update_count;
 382     memcpy (dest->atsi, update,
 383         update_count * sizeof(struct GNUNET_ATS_Information));
 384     (*delta_dest) =
 385         GNUNET_malloc (update_count * sizeof (struct GNUNET_ATS_Information));
 386     for (c1 = 0; c1 < update_count; c1++)
 387     {
 388       (*delta_dest)[c1].type = update[c1].type;
 389       (*delta_dest)[c1].value = htonl (GNUNET_ATS_VALUE_UNDEFINED);
 390     }
 391     (*delta_count) = update_count;
 392     return GNUNET_YES;
 393   }
 394
 395   for (c1 = 0; c1 < update_count; c1++)
 396   {
 397     /* Update existing performance information */
 398     found = GNUNET_NO;
 399     for (c2 = 0; c2 < dest->atsi_count; c2++)
 400     {
 401       if (update[c1].type == dest->atsi[c2].type)
 402       {
 403         if (update[c1].value != dest->atsi[c2].value)
 404         {
 405           /* Save previous value in delta */
 406           delta_atsi[delta_atsi_count] = dest->atsi[c2];
 407           delta_atsi_count++;
 408           /* Set new value */
 409           dest->atsi[c2].value = update[c1].value;
 410           change = GNUNET_YES;
 411         }
 412         found = GNUNET_YES;
 413         break;
 414       }
 415     }
 416     if (GNUNET_NO == found)
 417     {
 418       add_atsi[add_atsi_count] = update[c1];
 419       add_atsi_count++;
 420       delta_atsi[delta_atsi_count].type = update[c1].type;
 421       delta_atsi[delta_atsi_count].value = htonl (GNUNET_ATS_VALUE_UNDEFINED);
 422       delta_atsi_count++;
 423     }
 424   }
 425
 426   if (add_atsi_count > 0)
 427   {
 428     /* Extend ats performance information */
 429
 430     tmp_atsi = GNUNET_malloc ((dest->atsi_count + add_atsi_count) *
 431         (sizeof (struct GNUNET_ATS_Information)));
 432     memcpy (tmp_atsi, dest->atsi,
 433         dest->atsi_count * sizeof(struct GNUNET_ATS_Information));
 434     memcpy (&tmp_atsi[dest->atsi_count], add_atsi,
 435         add_atsi_count * sizeof(struct GNUNET_ATS_Information));
 436     GNUNET_free(dest->atsi);
 437     dest->atsi = tmp_atsi;
 438     dest->atsi_count = dest->atsi_count + add_atsi_count;
 439     change = GNUNET_YES;
 440   }
 441
 442   if (delta_atsi_count > 0)
 443   {
 444     /* Copy delta */
 445     (*delta_dest) =
 446         GNUNET_malloc (delta_atsi_count * sizeof (struct GNUNET_ATS_Information));
 447     memcpy ((*delta_dest), delta_atsi,
 448         delta_atsi_count * sizeof(struct GNUNET_ATS_Information));
 449     (*delta_count) = delta_atsi_count;
 450   }
 451
 452   return change;
 453 }
 454
 455 /**
 456  * Free the given address
 457  *
 458  * @param addr address to destroy
 459  */
 460 static void
 461 free_address (struct ATS_Address *addr)
 462 {
 463   GNUNET_free(addr->plugin);
 464   GNUNET_free_non_null(addr->atsi);
 465   GNUNET_free(addr);
 466 }
 467
 468 /**
 469  * Create a ATS_address with the given information
 470  *
 471  * @param peer peer
 472  * @param plugin_name plugin
 473  * @param plugin_addr address
 474  * @param plugin_addr_len address length
 475  * @param session_id session
 476  * @return the ATS_Address
 477  */
 478 static struct ATS_Address *
 479 create_address (const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
 480     const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id)
 481 {
 482   struct ATS_Address *aa = NULL;
 483   int c1;
 484   int c2;
 485
 486   aa = GNUNET_malloc (sizeof (struct ATS_Address) + plugin_addr_len);
 487   aa->peer = *peer;
 488   aa->addr_len = plugin_addr_len;
 489   aa->addr = &aa[1];
 490   memcpy (&aa[1], plugin_addr, plugin_addr_len);
 491   aa->plugin = GNUNET_strdup (plugin_name);
 492   aa->session_id = session_id;
 493   aa->active = GNUNET_NO;
 494   aa->used = GNUNET_NO;
 495   aa->solver_information = NULL;
 496   aa->atsi = NULL;
 497   aa->atsi_count = 0;
 498   aa->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0);
 499   aa->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0);
 500
 501   for (c1 = 0; c1 < GNUNET_ATS_QualityPropertiesCount; c1++)
 502   {
 503     aa->atsin[c1].avg_queue_index = 0;
 504     for (c2 = 0; c2 < GAS_normalization_queue_length; c2++)
 505       aa->atsin[c1].atsi_abs[c2] = GNUNET_ATS_VALUE_UNDEFINED;
 506   }
 507
 508   return aa;
 509 }
 510
 511 struct CompareAddressContext
 512 {
 513   const struct ATS_Address *search;
 514
 515   /* exact_address != NULL if address and session is equal */
 516   struct ATS_Address *exact_address;
 517   /* exact_address != NULL if address and session is 0 */
 518   struct ATS_Address *base_address;
 519 };
 520
 521
 522 /**
 523  * Comapre addresses
 524  *
 525  * @param cls a CompareAddressContext containin the source address
 526  * @param key peer id
 527  * @param value the address to compare with
 528  * @return #GNUNET_YES to continue, #GNUNET_NO if address is founce
 529  */
 530 static int
 531 compare_address_it (void *cls,
 532                     const struct GNUNET_PeerIdentity *key,
 533                     void *value)
 534 {
 535   struct CompareAddressContext *cac = cls;
 536   struct ATS_Address *aa = value;
 537
 538   /* Find an matching exact address:
 539    *
 540    * Compare by:
 541    * aa->addr_len == cac->search->addr_len
 542    * aa->plugin == cac->search->plugin
 543    * aa->addr == cac->search->addr
 544    * aa->session == cac->search->session
 545    *
 546    * return as exact address
 547    */
 548   if ((aa->addr_len == cac->search->addr_len)
 549       && (0 == strcmp (aa->plugin, cac->search->plugin)))
 550   {
 551     if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len))
 552         && (aa->session_id == cac->search->session_id))
 553       cac->exact_address = aa;
 554   }
 555
 556   /* Find an matching base address:
 557    *
 558    * Properties:
 559    *
 560    * aa->session_id == 0
 561    *
 562    * Compare by:
 563    * aa->addr_len == cac->search->addr_len
 564    * aa->plugin == cac->search->plugin
 565    * aa->addr == cac->search->addr
 566    *
 567    * return as base address
 568    */
 569   if ((aa->addr_len == cac->search->addr_len)
 570       && (0 == strcmp (aa->plugin, cac->search->plugin)))
 571   {
 572     if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len))
 573         && (aa->session_id == 0))
 574       cac->base_address = aa;
 575   }
 576
 577   /* Find an matching exact address based on session:
 578    *
 579    * Properties:
 580    *
 581    * cac->search->addr_len == 0
 582    *
 583    * Compare by:
 584    * aa->plugin == cac->search->plugin
 585    * aa->session_id == cac->search->session_id
 586    *
 587    * return as exact address
 588    */
 589   if (0 == cac->search->addr_len)
 590   {
 591     if ((0 == strcmp (aa->plugin, cac->search->plugin))
 592         && (aa->session_id == cac->search->session_id))
 593       cac->exact_address = aa;
 594   }
 595
 596   if (cac->exact_address == NULL )
 597     return GNUNET_YES; /* Continue iteration to find exact address */
 598   else
 599     return GNUNET_NO; /* Stop iteration since we have an exact address */
 600 }
 601
 602 /**
 603  * Find an existing equivalent address record.
 604  * Compares by peer identity and network address OR by session ID
 605  * (one of the two must match).
 606  *
 607  * @param handle the address handle
 608  * @param peer peer to lookup addresses for
 609  * @param addr existing address record
 610  * @return existing address record, NULL for none
 611  */
 612 struct ATS_Address *
 613 find_equivalent_address (struct GAS_Addresses_Handle *handle,
 614     const struct GNUNET_PeerIdentity *peer, const struct ATS_Address *addr)
 615 {
 616   struct CompareAddressContext cac;
 617
 618   cac.exact_address = NULL;
 619   cac.base_address = NULL;
 620   cac.search = addr;
 621   GNUNET_CONTAINER_multipeermap_get_multiple (handle->addresses,
 622                                               peer,
 623                                               &compare_address_it, &cac);
 624
 625   if (cac.exact_address == NULL)
 626     return cac.base_address;
 627   return cac.exact_address;
 628 }
 629
 630
 631 /**
 632  * Find the exact address
 633  *
 634  * @param handle the address handle to use
 635  * @param peer peer
 636  * @param plugin_name transport plugin name
 637  * @param plugin_addr plugin address
 638  * @param plugin_addr_len length of the plugin address
 639  * @param session_id session id, can be 0
 640  * @return an ATS_address or NULL
 641  */
 642
 643 static struct ATS_Address *
 644 find_exact_address (struct GAS_Addresses_Handle *handle,
 645     const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
 646     const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id)
 647 {
 648   struct ATS_Address *aa;
 649   struct ATS_Address *ea;
 650
 651   aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len,
 652       session_id);
 653
 654   /* Get existing address or address with session == 0 */
 655   ea = find_equivalent_address (handle, peer, aa);
 656   free_address (aa);
 657   if (ea == NULL )
 658     return NULL ;
 659   else if (ea->session_id != session_id)
 660     return NULL ;
 661   return ea;
 662 }
 663
 664 /**
 665  * Function allowing the solver to obtain normalized preference
 666  * values from solver
 667  *
 668  * @param cls unused
 669  * @param id the peer to return the normalized properties for
 670  * @return array of double values with |GNUNET_ATS_PreferenceCount| elements
 671  */
 672 const double *
 673 get_preferences_cb (void *cls, const struct GNUNET_PeerIdentity *id)
 674 {
 675   return GAS_normalization_get_preferences_by_peer (id);
 676 }
 677
 678 /**
 679  * Function allowing the solver to obtain normalized property
 680  * values for an address from solver
 681  *
 682  * @param cls unused
 683  * @param address the address
 684  * @return array of double values with |GNUNET_ATS_QualityPropertiesCount| elements
 685  */
 686 const double *
 687 get_property_cb (void *cls, const struct ATS_Address *address)
 688 {
 689   return GAS_normalization_get_properties ((struct ATS_Address *) address);
 690 }
 691
 692 /**
 693  * Extract an ATS performance info from an address
 694  *
 695  * @param address the address
 696  * @param type the type to extract in HBO
 697  * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
 698  */
 699 static int
 700 get_performance_info (struct ATS_Address *address, uint32_t type)
 701 {
 702   int c1;
 703   GNUNET_assert(NULL != address);
 704
 705   if ((NULL == address->atsi) || (0 == address->atsi_count))
 706     return GNUNET_ATS_VALUE_UNDEFINED;
 707
 708   for (c1 = 0; c1 < address->atsi_count; c1++)
 709   {
 710     if (ntohl (address->atsi[c1].type) == type)
 711       return ntohl (address->atsi[c1].value);
 712   }
 713   return GNUNET_ATS_VALUE_UNDEFINED;
 714 }
 715
 716 /**
 717  * Add a new address for a peer.
 718  *
 719  * @param handle the address handle to use
 720  * @param peer peer
 721  * @param plugin_name transport plugin name
 722  * @param plugin_addr plugin address
 723  * @param plugin_addr_len length of the plugin address
 724  * @param session_id session id, can be 0
 725  * @param atsi performance information for this address
 726  * @param atsi_count number of performance information contained
 727  */
 728 void
 729 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
 730     const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
 731     const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id,
 732     const struct GNUNET_ATS_Information *atsi, uint32_t atsi_count)
 733 {
 734   struct ATS_Address *new_address;
 735   struct ATS_Address *existing_address;
 736   struct GNUNET_ATS_Information *atsi_delta;
 737   uint32_t atsi_delta_count;
 738   uint32_t addr_net;
 739   uint32_t previous_session;
 740   int c1;
 741
 742   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Received `%s' for peer `%s'\n",
 743       "ADDRESS ADD", GNUNET_i2s (peer));
 744
 745   if (GNUNET_NO == handle->running)
 746     return;
 747
 748   GNUNET_assert(NULL != handle->addresses);
 749
 750   new_address = create_address (peer, plugin_name, plugin_addr, plugin_addr_len,
 751       session_id);
 752   atsi_delta = NULL;
 753   disassemble_ats_information (new_address, atsi, atsi_count, &atsi_delta,
 754       &atsi_delta_count);
 755   GNUNET_free_non_null(atsi_delta);
 756   addr_net = get_performance_info (new_address, GNUNET_ATS_NETWORK_TYPE);
 757   if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
 758     addr_net = GNUNET_ATS_NET_UNSPECIFIED;
 759
 760   /* Get existing address or address with session == 0 */
 761   existing_address = find_equivalent_address (handle, peer, new_address);
 762   if (existing_address == NULL )
 763   {
 764     /* Add a new address */
 765     GNUNET_assert(
 766         GNUNET_OK == GNUNET_CONTAINER_multipeermap_put (handle->addresses,
 767                                                         peer,
 768                                                         new_address,
 769                                                         GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
 770
 771     GNUNET_STATISTICS_set (handle->stat, "# addresses",
 772         GNUNET_CONTAINER_multipeermap_size (handle->addresses), GNUNET_NO);
 773
 774     GNUNET_log(GNUNET_ERROR_TYPE_INFO,
 775         "Adding new address %p for peer `%s', length %u, session id %u, %s\n",
 776         new_address,
 777         GNUNET_i2s (peer),
 778         plugin_addr_len, session_id,
 779         GNUNET_ATS_print_network_type (addr_net));
 780
 781     /* Tell solver about new address */
 782     handle->env.sf.s_add (handle->solver, new_address, addr_net);
 783
 784     handle->env.sf.s_bulk_start (handle->solver);
 785     GAS_normalization_normalize_property (handle->addresses, new_address, atsi,
 786         atsi_count);
 787     handle->env.sf.s_bulk_stop (handle->solver);
 788
 789     /* Notify performance clients about new address */
 790     GAS_performance_notify_all_clients (&new_address->peer, new_address->plugin,
 791         new_address->addr, new_address->addr_len, new_address->session_id,
 792         new_address->atsi, new_address->atsi_count,
 793         new_address->assigned_bw_out, new_address->assigned_bw_in);
 794     return;
 795   }
 796
 797   /* We have an existing address we can use, clean up new */
 798   GNUNET_free(new_address->plugin);
 799   GNUNET_free_non_null(new_address->atsi);
 800   GNUNET_free(new_address);
 801   new_address = NULL;
 802
 803   if (0 != existing_address->session_id)
 804   {
 805     /* Should not happen */
 806     GNUNET_break(0);
 807     return;
 808   }
 809
 810   addr_net = get_performance_info (existing_address, GNUNET_ATS_NETWORK_TYPE);
 811   if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
 812     addr_net = GNUNET_ATS_NET_UNSPECIFIED;
 813
 814   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 815       "Found existing address for peer `%s' %p with new session %u in network %s\n",
 816       GNUNET_i2s (peer), existing_address, session_id,
 817       GNUNET_ATS_print_network_type (addr_net));
 818   /* We have an address without an session, update this address */
 819   atsi_delta = NULL;
 820   atsi_delta_count = 0;
 821   if (GNUNET_YES
 822       == disassemble_ats_information (existing_address, atsi, atsi_count,
 823           &atsi_delta, &atsi_delta_count))
 824   {
 825     /* Notify performance clients about properties */
 826     GAS_performance_notify_all_clients (&existing_address->peer,
 827         existing_address->plugin, existing_address->addr,
 828         existing_address->addr_len, existing_address->session_id,
 829         existing_address->atsi, existing_address->atsi_count,
 830         existing_address->assigned_bw_out, existing_address->assigned_bw_in);
 831
 832     for (c1 = 0; c1 < atsi_delta_count; c1++)
 833     {
 834       if ((GNUNET_ATS_NETWORK_TYPE == ntohl (atsi_delta[c1].type))
 835           && (addr_net != ntohl (atsi_delta[c1].value)))
 836       {
 837         /* Network type changed */
 838         GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 839             "Address for peer `%s' %p changed from network %s to %s\n",
 840             GNUNET_i2s (peer), existing_address,
 841             GNUNET_ATS_print_network_type (addr_net),
 842             GNUNET_ATS_print_network_type (ntohl (atsi_delta[c1].value)));
 843         handle->env.sf.s_address_update_network (handle->solver, existing_address,
 844             ntohl (atsi_delta[c1].value),
 845             get_performance_info (existing_address, GNUNET_ATS_NETWORK_TYPE));
 846         addr_net = get_performance_info (existing_address,
 847             GNUNET_ATS_NETWORK_TYPE);
 848       }
 849     }
 850     /* Notify solver about update with atsi information and session */
 851     handle->env.sf.s_bulk_start (handle->solver);
 852     GAS_normalization_normalize_property (handle->addresses, existing_address,
 853         atsi, atsi_count);
 854     handle->env.sf.s_bulk_stop (handle->solver);
 855   }
 856   GNUNET_free_non_null(atsi_delta);
 857
 858   /* Notify solver about new session */
 859   if (existing_address->session_id == session_id)
 860     return; /* possible, can both be 0 since address is revalidated */
 861
 862   previous_session = existing_address->session_id;
 863   existing_address->session_id = session_id;
 864   handle->env.sf.s_address_update_session (handle->solver, existing_address,
 865       previous_session, session_id);
 866
 867   GNUNET_log(GNUNET_ERROR_TYPE_INFO,
 868       "Updated existing address for peer `%s' %p length %u with new session %u in network %s\n",
 869       GNUNET_i2s (peer), existing_address, existing_address->addr_len,
 870       session_id, GNUNET_ATS_print_network_type (addr_net));
 871 }
 872
 873 /**
 874  * Update an address with a session or performance information for a peer.
 875  *
 876  * If an address was added without a session it will be updated with the
 877  * session
 878  *
 879  * @param handle the address handle to use
 880  * @param peer peer
 881  * @param plugin_name transport plugin name
 882  * @param plugin_addr plugin address
 883  * @param plugin_addr_len length of the plugin address
 884  * @param session_id session id, can be 0
 885  * @param atsi performance information for this address
 886  * @param atsi_count number of performance information contained
 887  */
 888 void
 889 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
 890     const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
 891     const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id,
 892     const struct GNUNET_ATS_Information *atsi, uint32_t atsi_count)
 893 {
 894   struct ATS_Address *aa;
 895   struct GNUNET_ATS_Information *atsi_delta;
 896   uint32_t atsi_delta_count;
 897   uint32_t prev_session;
 898   int c1;
 899
 900   if (GNUNET_NO == handle->running)
 901     return;
 902
 903   GNUNET_assert(NULL != handle->addresses);
 904
 905   /* Get existing address */
 906   aa = find_exact_address (handle, peer, plugin_name, plugin_addr,
 907       plugin_addr_len, session_id);
 908   if (aa == NULL )
 909     return;
 910   if (NULL == aa->solver_information)
 911     return;
 912
 913   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Received `%s' for peer `%s' address \n",
 914       "ADDRESS UPDATE", GNUNET_i2s (peer), aa);
 915
 916   /* Update address */
 917   if (session_id != aa->session_id)
 918   {
 919     /* Session changed */
 920     prev_session = aa->session_id;
 921     aa->session_id = session_id;
 922     handle->env.sf.s_address_update_session (handle->solver, aa, prev_session,
 923         aa->session_id);
 924   }
 925
 926   atsi_delta = NULL;
 927   atsi_delta_count = 0;
 928   if (GNUNET_YES
 929       == disassemble_ats_information (aa, atsi, atsi_count, &atsi_delta,
 930           &atsi_delta_count))
 931   {
 932     /* ATS properties changed */
 933     for (c1 = 0; c1 < atsi_delta_count; c1++)
 934     {
 935       if (GNUNET_ATS_NETWORK_TYPE == ntohl (atsi_delta[c1].type))
 936       {
 937         /* Network type changed */
 938         handle->env.sf.s_address_update_network (handle->solver, aa,
 939             ntohl (atsi_delta[c1].value),
 940             get_performance_info (aa, GNUNET_ATS_NETWORK_TYPE));
 941       }
 942     }
 943
 944     /* Notify performance clients about updated address */
 945     GAS_performance_notify_all_clients (&aa->peer, aa->plugin, aa->addr,
 946         aa->addr_len, aa->session_id, aa->atsi, aa->atsi_count,
 947         aa->assigned_bw_out, aa->assigned_bw_in);
 948
 949     handle->env.sf.s_bulk_start (handle->solver);
 950     GAS_normalization_normalize_property (handle->addresses, aa, atsi,
 951         atsi_count);
 952     handle->env.sf.s_bulk_stop (handle->solver);
 953   }
 954   GNUNET_free_non_null(atsi_delta);
 955 }
 956
 957 struct DestroyContext
 958 {
 959   struct ATS_Address *aa;
 960
 961   struct GAS_Addresses_Handle *handle;
 962
 963   /**
 964    * GNUNET_NO  : full address
 965    * GNUNET_YES : just session
 966    */
 967   int result;
 968 };
 969
 970 /**
 971  * Delete an address
 972  *
 973  * If session != 0, just the session is deleted, the address itself still exists
 974  * If session == 0, remove full address
 975  * If session == 0 and addrlen == 0, destroy inbound address
 976  *
 977  * @param cls unused
 978  * @param key unused
 979  * @param value the 'struct ATS_Address'
 980  * @return GNUNET_OK (continue to iterate)
 981  */
 982 static int
 983 destroy_by_session_id (void *cls,
 984                        const struct GNUNET_PeerIdentity *key,
 985                        void *value)
 986 {
 987   struct DestroyContext *dc = cls;
 988   struct GAS_Addresses_Handle *handle = dc->handle;
 989   const struct ATS_Address *des = dc->aa;
 990   struct ATS_Address *aa = value;
 991
 992   GNUNET_assert(
 993       0 == memcmp (&aa->peer, &des->peer, sizeof(struct GNUNET_PeerIdentity)));
 994
 995   if (des->session_id == 0)
 996   {
 997     /* Session == 0, remove full address  */
 998     if ((0 == strcmp (des->plugin, aa->plugin))
 999         && (aa->addr_len == des->addr_len)
1000         && (0 == memcmp (des->addr, aa->addr, aa->addr_len)))
1001     {
1002
1003       GNUNET_log(GNUNET_ERROR_TYPE_INFO,
1004           "Deleting full address for peer `%s' session %u %p\n",
1005           GNUNET_i2s (&aa->peer), aa->session_id, aa);
1006
1007       /* Notify solver about deletion */
1008       GNUNET_assert(
1009           GNUNET_YES == GNUNET_CONTAINER_multipeermap_remove (handle->addresses,
1010                                                               &aa->peer,
1011                                                               aa));
1012       handle->env.sf.s_del (handle->solver, aa, GNUNET_NO);
1013       free_address (aa);
1014       dc->result = GNUNET_NO;
1015       return GNUNET_OK; /* Continue iteration */
1016     }
1017   }
1018   else
1019   {
1020     /* Session != 0, just remove session */
1021     if (aa->session_id != des->session_id)
1022       return GNUNET_OK; /* irrelevant */
1023
1024     if ((aa->session_id != 0) && (0 != strcmp (des->plugin, aa->plugin)))
1025     {
1026       GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
1027           "Different plugins during removal: `%s' vs `%s' \n", des->plugin,
1028           aa->plugin);
1029       GNUNET_break(0);
1030       return GNUNET_OK;
1031     }
1032
1033     if (aa->addr_len == 0)
1034     {
1035       /* Inbound connection died, delete full address */
1036       GNUNET_log(GNUNET_ERROR_TYPE_INFO,
1037           "Deleting inbound address for peer `%s': `%s' session %u\n",
1038           GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
1039
1040       /* Notify solver about deletion */
1041       GNUNET_assert(
1042           GNUNET_YES == GNUNET_CONTAINER_multipeermap_remove (handle->addresses,
1043                                                               &aa->peer, aa));
1044       handle->env.sf.s_del (handle->solver, aa, GNUNET_NO);
1045       free_address (aa);
1046       dc->result = GNUNET_NO;
1047       return GNUNET_OK; /* Continue iteration */
1048     }
1049     else
1050     {
1051       /* Session died */
1052       GNUNET_log(GNUNET_ERROR_TYPE_INFO,
1053           "Deleting session for peer `%s': `%s' %u\n", GNUNET_i2s (&aa->peer),
1054           aa->plugin, aa->session_id);
1055       /* Notify solver to delete session */
1056       handle->env.sf.s_del (handle->solver, aa, GNUNET_YES);
1057       aa->session_id = 0;
1058       aa->active = GNUNET_NO;
1059       return GNUNET_OK;
1060     }
1061   }
1062   return GNUNET_OK;
1063 }
1064
1065
1066 /**
1067  * Remove an address or just a session for a peer.
1068  *
1069  * @param handle the address handle to use
1070  * @param peer peer
1071  * @param plugin_name transport plugin name
1072  * @param plugin_addr plugin address
1073  * @param plugin_addr_len length of the plugin address
1074  * @param session_id session id, can be 0
1075  */
1076 void
1077 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
1078     const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
1079     const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id)
1080 {
1081   struct ATS_Address *ea;
1082   struct DestroyContext dc;
1083   if (GNUNET_NO == handle->running)
1084     return;
1085
1086   /* Get existing address */
1087   ea = find_exact_address (handle, peer, plugin_name, plugin_addr,
1088       plugin_addr_len, session_id);
1089   if (ea == NULL )
1090   {
1091     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1092         "Tried to destroy unknown address for peer `%s' `%s' session id %u\n",
1093         GNUNET_i2s (peer), plugin_name, session_id);
1094     return;
1095   }
1096
1097   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1098       "Received `%s' for peer `%s' address %p session %u\n", "ADDRESS DESTROY",
1099       GNUNET_i2s (peer), ea, session_id);
1100
1101   GNUNET_break(0 < strlen (plugin_name));
1102   dc.handle = handle;
1103   dc.aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len,
1104       session_id);
1105
1106   GNUNET_CONTAINER_multipeermap_get_multiple (handle->addresses,
1107                                               peer,
1108                                               &destroy_by_session_id, &dc);
1109   GNUNET_STATISTICS_set (handle->stat, "# addresses",
1110       GNUNET_CONTAINER_multipeermap_size (handle->addresses), GNUNET_NO);
1111   free_address (dc.aa);
1112 }
1113
1114 /**
1115  * Notification about active use of an address.
1116  * in_use == GNUNET_YES:
1117  *      This address is used to maintain an active connection with a peer.
1118  * in_use == GNUNET_NO:
1119  *      This address is no longer used to maintain an active connection with a peer.
1120  *
1121  * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
1122  * before
1123  *
1124  * @param handle the address handle to use
1125  * @param peer peer
1126  * @param plugin_name transport plugin name
1127  * @param plugin_addr plugin address
1128  * @param plugin_addr_len length of the plugin address
1129  * @param session_id session id, can be 0
1130  * @param in_use GNUNET_YES if GNUNET_NO
1131  * @return GNUNET_SYSERR on failure (address unknown ...)
1132  */
1133 int
1134 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
1135     const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
1136     const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id,
1137     int in_use)
1138 {
1139   struct ATS_Address *ea;
1140   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Received `%s' for peer `%s'\n",
1141       "ADDRESS IN USE", GNUNET_i2s (peer));
1142
1143   if (GNUNET_NO == handle->running)
1144     return GNUNET_SYSERR;
1145
1146   ea = find_exact_address (handle, peer, plugin_name, plugin_addr,
1147       plugin_addr_len, session_id);
1148   if (NULL == ea)
1149   {
1150     GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
1151         "Trying to set unknown address `%s' `%s' `%u' to %s \n",
1152         GNUNET_i2s (peer), plugin_name, session_id,
1153         (GNUNET_NO == in_use) ? "NO" : "YES");
1154     GNUNET_break(0);
1155     return GNUNET_SYSERR;
1156   }
1157   if (ea->used == in_use)
1158   {
1159     GNUNET_break(0);
1160     GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
1161         "Address in use called multiple times for peer `%s': %s -> %s \n",
1162         GNUNET_i2s (peer), (GNUNET_NO == ea->used) ? "NO" : "YES",
1163         (GNUNET_NO == in_use) ? "NO" : "YES");
1164     return GNUNET_SYSERR;
1165   }
1166
1167   /* Tell solver about update */
1168   ea->used = in_use;
1169   handle->env.sf.s_address_update_inuse (handle->solver, ea, ea->used);
1170   return GNUNET_OK;
1171 }
1172
1173 /**
1174  * Cancel address suggestions for a peer
1175  *
1176  * @param handle the address handle
1177  * @param peer the peer id
1178  */
1179 void
1180 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
1181     const struct GNUNET_PeerIdentity *peer)
1182 {
1183   struct GAS_Addresses_Suggestion_Requests *cur = handle->pending_requests_head;
1184
1185   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Received request: `%s' for peer %s\n",
1186       "request_address_cancel", GNUNET_i2s (peer));
1187
1188   while (NULL != cur)
1189   {
1190     if (0 == memcmp (peer, &cur->id, sizeof(cur->id)))
1191       break; /* found */
1192     cur = cur->next;
1193   }
1194
1195   if (NULL == cur)
1196   {
1197     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1198         "No address requests pending for peer `%s', cannot remove!\n",
1199         GNUNET_i2s (peer));
1200     return;
1201   }
1202   handle->env.sf.s_get_stop (handle->solver, peer);
1203   GAS_addresses_handle_backoff_reset (handle, peer);
1204   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Removed request pending for peer `%s\n",
1205       GNUNET_i2s (peer));
1206   GNUNET_CONTAINER_DLL_remove(handle->pending_requests_head, handle->pending_requests_tail, cur);
1207   GNUNET_free(cur);
1208 }
1209
1210
1211 /**
1212  * Request address suggestions for a peer
1213  *
1214  * @param handle the address handle
1215  * @param peer the peer id
1216  */
1217 void
1218 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
1219     const struct GNUNET_PeerIdentity *peer)
1220 {
1221   struct GAS_Addresses_Suggestion_Requests *cur = handle->pending_requests_head;
1222   struct ATS_Address *aa;
1223
1224   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Received `%s' for peer `%s'\n",
1225       "REQUEST ADDRESS", GNUNET_i2s (peer));
1226
1227   if (GNUNET_NO == handle->running)
1228     return;
1229   while (NULL != cur)
1230   {
1231     if (0 == memcmp (peer, &cur->id, sizeof(cur->id)))
1232       break; /* already suggesting */
1233     cur = cur->next;
1234   }
1235   if (NULL == cur)
1236   {
1237     cur = GNUNET_malloc (sizeof (struct GAS_Addresses_Suggestion_Requests));
1238     cur->id = (*peer);
1239     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1240         "Adding new address suggestion request for `%s'\n",
1241          GNUNET_i2s (peer));
1242     GNUNET_CONTAINER_DLL_insert(handle->pending_requests_head, handle->pending_requests_tail, cur);
1243   }
1244
1245   /* Get prefered address from solver */
1246   aa = (struct ATS_Address *) handle->env.sf.s_get (handle->solver, peer);
1247   if (NULL == aa)
1248   {
1249     GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Cannot suggest address for peer `%s'\n",
1250         GNUNET_i2s (peer));
1251     return;
1252   }
1253
1254   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Suggesting address %p for peer `%s'\n",
1255       aa, GNUNET_i2s (peer));
1256
1257   GAS_scheduling_transmit_address_suggestion (peer, aa->plugin, aa->addr,
1258       aa->addr_len, aa->session_id, aa->atsi, aa->atsi_count,
1259       aa->assigned_bw_out, aa->assigned_bw_in);
1260
1261   aa->block_interval = GNUNET_TIME_relative_add (aa->block_interval,
1262       ATS_BLOCKING_DELTA);
1263   aa->blocked_until = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get (),
1264       aa->block_interval);
1265
1266   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1267       "Address %p ready for suggestion, block interval now %llu \n", aa,
1268       aa->block_interval);
1269 }
1270
1271 /**
1272  * Iterator to reset address blocking
1273  *
1274  * @param cls not used
1275  * @param key the peer
1276  * @param value the address to reset
1277  * @return #GNUNET_OK to continue
1278  */
1279 static int
1280 reset_address_it (void *cls,
1281                   const struct GNUNET_PeerIdentity *key,
1282                   void *value)
1283 {
1284   struct ATS_Address *aa = value;
1285
1286   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1287              "Resetting interval for peer `%s' address %p from %llu to 0\n",
1288              GNUNET_i2s (&aa->peer),
1289              aa,
1290              aa->block_interval);
1291   aa->blocked_until = GNUNET_TIME_UNIT_ZERO_ABS;
1292   aa->block_interval = GNUNET_TIME_UNIT_ZERO;
1293   return GNUNET_OK;
1294 }
1295
1296
1297 /**
1298  * Reset suggestion backoff for a peer
1299  *
1300  * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
1301  * reset using this function
1302  *
1303  * @param handle the address handle
1304  * @param peer the peer id
1305  */
1306 void
1307 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
1308     const struct GNUNET_PeerIdentity *peer)
1309 {
1310   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Received `%s' for peer `%s'\n",
1311       "RESET BACKOFF", GNUNET_i2s (peer));
1312
1313   GNUNET_break(
1314       GNUNET_SYSERR != GNUNET_CONTAINER_multipeermap_get_multiple (handle->addresses,
1315                                                                    peer,
1316                                                                    &reset_address_it, NULL));
1317 }
1318
1319
1320
1321 static int
1322 eval_count_active_it (void *cls, const struct GNUNET_PeerIdentity *id, void *obj)
1323 {
1324   int *request_fulfilled = cls;
1325   struct ATS_Address *addr = obj;
1326
1327   if (GNUNET_YES == addr->active)
1328     (*request_fulfilled) = GNUNET_YES;
1329
1330   if (*request_fulfilled == GNUNET_YES)
1331     return GNUNET_NO;
1332   else
1333     return GNUNET_YES;
1334 }
1335
1336
1337 /**
1338  * Summary context
1339  */
1340 struct SummaryContext {
1341   /**
1342    * Sum of the utilized inbound bandwidth per network
1343    */
1344   unsigned long long bandwidth_in_assigned[GNUNET_ATS_NetworkTypeCount];
1345
1346   /**
1347    * Sum of the utilized outbound bandwidth per network
1348    */
1349   unsigned long long bandwidth_out_assigned[GNUNET_ATS_NetworkTypeCount];
1350
1351   /**
1352    * Sum addresses within a network
1353    */
1354   unsigned int addresses_in_network[GNUNET_ATS_NetworkTypeCount];
1355 };
1356
1357
1358 static int
1359 eval_sum_bw_used (void *cls, const struct GNUNET_PeerIdentity *id, void *obj)
1360 {
1361   struct ATS_Address *addr = obj;
1362   int networks[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1363   int net;
1364   struct SummaryContext  *ctx = cls;
1365
1366   int c;
1367
1368   if (GNUNET_YES == addr->active)
1369   {
1370     net = get_performance_info (addr, GNUNET_ATS_NETWORK_TYPE);
1371     for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
1372     {
1373       if (net == networks[c])
1374       {
1375         ctx->addresses_in_network[c] ++;
1376         ctx->bandwidth_in_assigned[c] += ntohl (addr->assigned_bw_in.value__);
1377         ctx->bandwidth_out_assigned[c] += ntohl (addr->assigned_bw_out.value__);
1378       }
1379     }
1380     GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Active address in  %s with (in/out) %llu/%llu Bps\n",
1381         GNUNET_ATS_print_network_type(net),
1382         ntohl (addr->assigned_bw_in.value__),
1383         ntohl (addr->assigned_bw_out.value__));
1384   }
1385   return GNUNET_OK;
1386 }
1387
1388 /**
1389  * Summary context
1390  */
1391 struct RelativityContext {
1392
1393   struct GAS_Addresses_Handle *ah;
1394 };
1395
1396 static int
1397 find_active_address (void *cls, const struct GNUNET_PeerIdentity *id, void *obj)
1398 {
1399   struct ATS_Address **res = cls;
1400   struct ATS_Address *addr = obj;
1401
1402   if (GNUNET_YES == addr->active)
1403     (*res) = addr;
1404
1405   if (NULL != (*res))
1406     return GNUNET_NO;
1407   else
1408     return GNUNET_YES;
1409 }
1410
1411 /**
1412  * Evaluate current bandwidth assignment
1413  *
1414  * @param ah address handle
1415  */
1416 void
1417 GAS_addresses_evaluate_assignment (struct GAS_Addresses_Handle *ah)
1418 {
1419   struct GAS_Addresses_Suggestion_Requests *cur;
1420   struct GAS_Addresses_Preference_Clients *pcur;
1421   int c;
1422
1423   float quality_requests_fulfilled = 0.0;
1424   float quality_bandwidth_utilization[GNUNET_ATS_NetworkTypeCount];
1425   float quality_bandwidth_utilization_total = 0.0;
1426   float quality_application_requirements = 0.0;
1427   float guq = 0.0;
1428
1429   int include_requests;
1430   int include_utilization;
1431   int include_requirements;
1432
1433   /* Variable related to requests */
1434   unsigned int requests_pending;
1435   unsigned int requests_fulfilled;
1436   unsigned int request_active;
1437
1438   /* Variable related to utilization */
1439   struct SummaryContext sum;
1440   struct ATS_Address *active_address;
1441   int network_count;
1442
1443   /* Variables for preferences */
1444   int prefs[GNUNET_ATS_PreferenceCount] = GNUNET_ATS_PreferenceType;
1445   double pref_val;
1446   double prop_val;
1447   const double *norm_values;
1448   double prefs_fulfill[GNUNET_ATS_PreferenceCount];
1449   int prefs_clients[GNUNET_ATS_PreferenceCount];
1450   int rels;
1451
1452   GNUNET_assert (NULL != ah);
1453   GNUNET_assert (NULL != ah->addresses);
1454
1455   requests_pending = 0;
1456   requests_fulfilled = 0;
1457   /* 1) How many requests could be fulfilled? */
1458   for (cur = ah->pending_requests_head; NULL != cur; cur = cur->next)
1459   {
1460     request_active = GNUNET_NO;
1461     GNUNET_CONTAINER_multipeermap_get_multiple (ah->addresses,
1462         &cur->id, &eval_count_active_it, &request_active);
1463     if (GNUNET_YES == request_active)
1464       requests_fulfilled ++;
1465     requests_pending ++;
1466     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%s': %u pending requests, %s\n",
1467         GNUNET_i2s (&cur->id),
1468         requests_pending,
1469         (GNUNET_YES == request_active) ? "active adress" : "no active address");
1470
1471   }
1472   if (requests_pending > 0)
1473   {
1474     quality_requests_fulfilled = (float) requests_fulfilled / requests_pending;
1475     include_requests = GNUNET_YES;
1476   }
1477   else
1478   {
1479     quality_requests_fulfilled = 0.0;
1480     include_requests = GNUNET_NO;
1481   }
1482   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "%u pending requests, %u requests fullfilled\n",
1483       requests_pending, requests_fulfilled);
1484
1485   /* 2) How well is bandwidth utilized? */
1486   network_count = 0;
1487   for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
1488   {
1489     quality_bandwidth_utilization[c] = 0.0;
1490     sum.addresses_in_network[c] = 0;
1491     sum.bandwidth_in_assigned[c] = 0;
1492     sum.bandwidth_out_assigned[c] = 0;
1493   }
1494   GNUNET_CONTAINER_multipeermap_iterate(ah->addresses,
1495       &eval_sum_bw_used, &sum);
1496   for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
1497   {
1498     quality_bandwidth_utilization[c] = (((float)sum.bandwidth_out_assigned[c] / ah->env.out_quota[c]) +
1499         ((float)sum.bandwidth_in_assigned[c] / ah->env.in_quota[c])) / 2;
1500
1501     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Utilization for network `%s': %f\n",
1502          GNUNET_ATS_print_network_type(ah->env.networks[c]),
1503          quality_bandwidth_utilization[c]);
1504     if (sum.addresses_in_network[c] > 0)
1505     {
1506       quality_bandwidth_utilization_total += quality_bandwidth_utilization[c];
1507       network_count ++;
1508     }
1509   }
1510   if (0 < network_count)
1511   {
1512     quality_bandwidth_utilization_total /= network_count;
1513     include_utilization = GNUNET_YES;
1514   }
1515   else
1516   {
1517     quality_bandwidth_utilization_total = 0.0;
1518     include_utilization = GNUNET_NO;
1519   }
1520
1521   /* 3) How well does selection match application requirements */
1522   if (0 == ah->pref_clients)
1523   {
1524     include_requirements = 0;
1525   }
1526   else
1527   {
1528     for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
1529     {
1530       prefs_fulfill[c] = 0.0;
1531       prefs_clients[c] = 0;
1532     }
1533
1534     for (cur = ah->pending_requests_head; NULL != cur; cur = cur->next)
1535     {
1536       active_address = NULL;
1537       GNUNET_CONTAINER_multipeermap_get_multiple (ah->addresses,
1538           &cur->id, &find_active_address, &active_address);
1539
1540       for (pcur = ah->preference_clients_head; NULL != pcur; pcur = pcur->next)
1541       {
1542         for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
1543         {
1544           if (prefs[c] == GNUNET_ATS_PREFERENCE_END)
1545             continue;
1546           pref_val = GAS_normalization_get_preferences_by_client (pcur->client, &cur->id, prefs[c]);
1547           if (-1.0 == pref_val)
1548           {
1549             GNUNET_break (0);
1550             continue;
1551           }
1552
1553           if (DEFAULT_REL_PREFERENCE == pref_val)
1554           {
1555             /* Default preference value */
1556             continue;
1557           }
1558
1559           if (NULL != active_address)
1560           {
1561             norm_values = GAS_normalization_get_properties (active_address);
1562             prop_val = norm_values[c];
1563             if ((norm_values[c] <= 1.0) || (norm_values[c] >= 2.0))
1564                 prop_val = DEFAULT_REL_QUALITY;
1565           }
1566           else
1567           {
1568             prop_val = DEFAULT_REL_QUALITY;
1569           }
1570
1571           /* We now have preference values [1..2] and properties [1..2] */
1572
1573           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "%u Client %p, Peer %s Property %s: pref: %.3f prop %.3f \n",
1574               c,
1575               pcur->client,
1576               GNUNET_i2s (&cur->id),
1577               GNUNET_ATS_print_preference_type(prefs[c]),
1578               pref_val,
1579               prop_val);
1580
1581           prefs_fulfill[c] += (pref_val * prop_val) / 2;
1582           prefs_clients[c] ++;
1583         }
1584       }
1585     }
1586     rels = 0;
1587     for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
1588     {
1589       if (0 < prefs_clients[c])
1590       {
1591         prefs_fulfill[c] /= prefs_clients[c];
1592         rels ++;
1593         quality_application_requirements += prefs_fulfill[c];
1594       }
1595     }
1596     if (rels > 0)
1597       quality_application_requirements /= rels;
1598     else
1599       quality_application_requirements = 0.0;
1600
1601     include_requirements = 1;
1602   }
1603   /* GUQ */
1604
1605   if (include_requests + include_utilization + include_requirements > 0)
1606     guq = (quality_requests_fulfilled + quality_bandwidth_utilization_total + quality_application_requirements) /
1607       (include_requests + include_utilization + include_requirements);
1608   else
1609     guq = 0.0;
1610
1611   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1612       "Requests fulfilled %.3f bandwidth utilized %.3f application preferences met %.3f => %.3f\n",
1613       quality_requests_fulfilled,
1614       quality_bandwidth_utilization_total,
1615       quality_application_requirements,
1616       guq);
1617 }
1618
1619 /**
1620  * Solver information callback
1621  *
1622  * @param cls the closure
1623  * @param op the operation
1624  * @param stat operation status
1625  * @param add additional information
1626  */
1627
1628 static void
1629 solver_info_cb (void *cls,
1630     enum GAS_Solver_Operation op,
1631     enum GAS_Solver_Status stat,
1632     enum GAS_Solver_Additional_Information add)
1633 {
1634   char *add_info;
1635
1636   switch (add) {
1637     case GAS_INFO_NONE:
1638       add_info = "GAS_INFO_NONE";
1639       break;
1640     case GAS_INFO_FULL:
1641       add_info = "GAS_INFO_MLP_FULL";
1642       break;
1643     case GAS_INFO_UPDATED:
1644       add_info = "GAS_INFO_MLP_UPDATED";
1645       break;
1646     case GAS_INFO_PROP_ALL:
1647       add_info = "GAS_INFO_PROP_ALL";
1648       break;
1649     case GAS_INFO_PROP_SINGLE:
1650       add_info = "GAS_INFO_PROP_SINGLE";
1651       break;
1652     default:
1653       add_info = "INVALID";
1654       break;
1655   }
1656   switch (op)
1657   {
1658     case GAS_OP_SOLVE_START:
1659       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1660           "Solver notifies `%s' with result `%s' `%s'\n", "GAS_OP_SOLVE_START",
1661           (GAS_STAT_SUCCESS == stat) ? "SUCCESS" : "FAIL", add_info);
1662       return;
1663     case GAS_OP_SOLVE_STOP:
1664       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1665           "Solver notifies `%s' with result `%s'\n", "GAS_OP_SOLVE_STOP",
1666           (GAS_STAT_SUCCESS == stat) ? "SUCCESS" : "FAIL", add_info);
1667       return;
1668
1669     case GAS_OP_SOLVE_SETUP_START:
1670       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1671           "Solver notifies `%s' with result `%s'\n", "GAS_OP_SOLVE_SETUP_START",
1672           (GAS_STAT_SUCCESS == stat) ? "SUCCESS" : "FAIL");
1673       return;
1674
1675     case GAS_OP_SOLVE_SETUP_STOP:
1676       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1677           "Solver notifies `%s' with result `%s'\n", "GAS_OP_SOLVE_SETUP_STOP",
1678           (GAS_STAT_SUCCESS == stat) ? "SUCCESS" : "FAIL");
1679       return;
1680
1681     case GAS_OP_SOLVE_MLP_LP_START:
1682       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1683           "Solver notifies `%s' with result `%s'\n", "GAS_OP_SOLVE_LP_START",
1684           (GAS_STAT_SUCCESS == stat) ? "SUCCESS" : "FAIL");
1685       return;
1686     case GAS_OP_SOLVE_MLP_LP_STOP:
1687       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1688           "Solver notifies `%s' with result `%s'\n", "GAS_OP_SOLVE_LP_STOP",
1689           (GAS_STAT_SUCCESS == stat) ? "SUCCESS" : "FAIL");
1690       return;
1691
1692     case GAS_OP_SOLVE_MLP_MLP_START:
1693       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1694           "Solver notifies `%s' with result `%s'\n", "GAS_OP_SOLVE_MLP_START",
1695           (GAS_STAT_SUCCESS == stat) ? "SUCCESS" : "FAIL");
1696       return;
1697     case GAS_OP_SOLVE_MLP_MLP_STOP:
1698       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1699           "Solver notifies `%s' with result `%s'\n", "GAS_OP_SOLVE_MLP_STOP",
1700           (GAS_STAT_SUCCESS == stat) ? "SUCCESS" : "FAIL");
1701       return;
1702     case GAS_OP_SOLVE_UPDATE_NOTIFICATION_START:
1703       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1704           "Solver notifies `%s' with result `%s'\n", "GAS_OP_SOLVE_UPDATE_NOTIFICATION_START",
1705           (GAS_STAT_SUCCESS == stat) ? "SUCCESS" : "FAIL");
1706       return;
1707     case GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP:
1708       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1709           "Solver notifies `%s' with result `%s'\n", "GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP",
1710           (GAS_STAT_SUCCESS == stat) ? "SUCCESS" : "FAIL");
1711       GAS_addresses_evaluate_assignment (cls);
1712       return;
1713     default:
1714       break;
1715     }
1716 }
1717
1718
1719 /**
1720  * The preference changed for a peer
1721  *
1722  * @param cls the address handle
1723  * @param peer the peer
1724  * @param kind the ATS kind
1725  * @param pref_rel the new relative preference value
1726  */
1727 static void
1728 normalized_preference_changed_cb (void *cls,
1729     const struct GNUNET_PeerIdentity *peer, enum GNUNET_ATS_PreferenceKind kind,
1730     double pref_rel)
1731 {
1732   GNUNET_assert(NULL != cls);
1733   struct GAS_Addresses_Handle *handle = cls;
1734
1735   /* Tell solver about update */
1736   handle->env.sf.s_pref (handle->solver, peer, kind, pref_rel);
1737 }
1738
1739 /**
1740  * The relative value for a property changed
1741  *
1742  * @param cls the address handle
1743  * @param address the peer
1744  * @param type the ATS type
1745  * @param prop_rel the new relative preference value
1746  */
1747 static void
1748 normalized_property_changed_cb (void *cls, struct ATS_Address *address,
1749     uint32_t type, double prop_rel)
1750 {
1751   struct GAS_Addresses_Handle *ah = (struct GAS_Addresses_Handle *) cls;
1752   GNUNET_assert(NULL != ah);
1753
1754   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1755       "Normalized property %s for peer `%s' changed to %.3f \n",
1756       GNUNET_ATS_print_property_type (type), GNUNET_i2s (&address->peer),
1757       prop_rel);
1758
1759   ah->env.sf.s_address_update_property (ah->solver, address, type, 0, prop_rel);
1760 }
1761
1762 static struct GAS_Addresses_Preference_Clients *
1763 find_preference_client (struct GAS_Addresses_Handle *handle, void *client)
1764 {
1765   struct GAS_Addresses_Preference_Clients *cur;
1766
1767   for (cur = handle->preference_clients_head; NULL != cur; cur = cur->next)
1768   {
1769     if (cur->client == client)
1770       return cur;
1771   }
1772   return NULL;
1773 }
1774
1775 /**
1776  * A performance client disconnected
1777  *
1778  * @param handle address handle
1779  * @param client the client
1780  */
1781
1782 void
1783 GAS_addresses_preference_client_disconnect (struct GAS_Addresses_Handle *handle,
1784     void *client)
1785 {
1786   struct GAS_Addresses_Preference_Clients * pc;
1787   if (NULL != (pc = find_preference_client (handle, client)))
1788   {
1789     GNUNET_CONTAINER_DLL_remove (handle->preference_clients_head,
1790         handle->preference_clients_tail, pc);
1791     GNUNET_free (pc);
1792     GNUNET_assert (handle->pref_clients > 0);
1793     handle->pref_clients --;
1794     GNUNET_STATISTICS_set (handle->stat, "# active performance clients", handle->pref_clients, GNUNET_NO);
1795   }
1796   GAS_normalization_preference_client_disconnect (client);
1797 }
1798
1799 /**
1800  * Change the preference for a peer
1801  *
1802  * @param handle the address handle
1803  * @param client the client sending this request
1804  * @param peer the peer id
1805  * @param kind the preference kind to change
1806  * @param score_abs the new preference score
1807  */
1808 void
1809 GAS_addresses_preference_change (struct GAS_Addresses_Handle *handle,
1810     void *client, const struct GNUNET_PeerIdentity *peer,
1811     enum GNUNET_ATS_PreferenceKind kind, float score_abs)
1812 {
1813   struct GAS_Addresses_Preference_Clients * pc;
1814   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1815       "Received `%s' for peer `%s' for client %p\n", "CHANGE PREFERENCE",
1816       GNUNET_i2s (peer), client);
1817
1818   if (GNUNET_NO == handle->running)
1819     return;
1820
1821   if (GNUNET_NO ==
1822       GNUNET_CONTAINER_multipeermap_contains (handle->addresses,
1823                                               peer))
1824   {
1825     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1826         "Received `%s' for unknown peer `%s' from client %p\n",
1827         "CHANGE PREFERENCE", GNUNET_i2s (peer), client);
1828     return;
1829   }
1830
1831   if (NULL == find_preference_client (handle, client))
1832   {
1833     pc = GNUNET_malloc (sizeof (struct GAS_Addresses_Preference_Clients));
1834     pc->client = client;
1835     GNUNET_CONTAINER_DLL_insert (handle->preference_clients_head,
1836         handle->preference_clients_tail, pc);
1837     handle->pref_clients ++;
1838     GNUNET_STATISTICS_set (handle->stat, "# active performance clients", handle->pref_clients, GNUNET_NO);
1839   }
1840
1841   handle->env.sf.s_bulk_start (handle->solver);
1842   /* Tell normalization about change, normalization will call callback if preference changed */
1843   GAS_normalization_normalize_preference (client, peer, kind, score_abs);
1844   handle->env.sf.s_bulk_stop (handle->solver);
1845 }
1846
1847 /**
1848  * Change the preference for a peer
1849  *
1850  * @param handle the address handle
1851  * @param application the client sending this request
1852  * @param peer the peer id
1853  * @param scope the time interval for this feedback: [now - scope .. now]
1854  * @param kind the preference kind to change
1855  * @param score_abs the new preference score
1856  */
1857 void
1858 GAS_addresses_preference_feedback (struct GAS_Addresses_Handle *handle,
1859     void *application, const struct GNUNET_PeerIdentity *peer,
1860     const struct GNUNET_TIME_Relative scope,
1861     enum GNUNET_ATS_PreferenceKind kind, float score_abs)
1862 {
1863   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1864       "Received `%s' for peer `%s' for client %p\n", "PREFERENCE FEEDBACK",
1865       GNUNET_i2s (peer), application);
1866
1867   if (GNUNET_NO == handle->running)
1868     return;
1869
1870   if (GNUNET_NO ==
1871       GNUNET_CONTAINER_multipeermap_contains (handle->addresses,
1872                                               peer))
1873   {
1874     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1875         "Received `%s' for unknown peer `%s' from client %p\n",
1876         "PREFERENCE FEEDBACK", GNUNET_i2s (peer), application);
1877     return;
1878   }
1879
1880   handle->env.sf.s_feedback (handle->solver, application, peer, scope, kind,
1881       score_abs);
1882 }
1883
1884 /**
1885  * Load quotas for networks from configuration
1886  *
1887  * @param cfg configuration handle
1888  * @param out_dest where to write outbound quotas
1889  * @param in_dest where to write inbound quotas
1890  * @param dest_length length of inbound and outbound arrays
1891  * @return number of networks loaded
1892  */
1893 static unsigned int
1894 load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg,
1895     unsigned long long *out_dest, unsigned long long *in_dest, int dest_length)
1896 {
1897   char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1898   char * entry_in = NULL;
1899   char * entry_out = NULL;
1900   char * quota_out_str;
1901   char * quota_in_str;
1902   int c;
1903   int res;
1904
1905   for (c = 0; (c < GNUNET_ATS_NetworkTypeCount) && (c < dest_length); c++)
1906   {
1907     in_dest[c] = 0;
1908     out_dest[c] = 0;
1909     GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
1910     GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
1911
1912     /* quota out */
1913     if (GNUNET_OK
1914         == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", entry_out,
1915             &quota_out_str))
1916     {
1917       res = GNUNET_NO;
1918       if (0 == strcmp (quota_out_str, GNUNET_ATS_MaxBandwidthString))
1919       {
1920         out_dest[c] = GNUNET_ATS_MaxBandwidth;
1921         res = GNUNET_YES;
1922       }
1923       if ((GNUNET_NO == res)
1924           && (GNUNET_OK
1925               == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str,
1926                   &out_dest[c])))
1927         res = GNUNET_YES;
1928       if ((GNUNET_NO == res)
1929           && (GNUNET_OK
1930               == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_out,
1931                   &out_dest[c])))
1932         res = GNUNET_YES;
1933
1934       if (GNUNET_NO == res)
1935       {
1936         GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
1937             _("Could not load quota for network `%s':  `%s', assigning default bandwidth %llu\n"),
1938             network_str[c], quota_out_str, GNUNET_ATS_DefaultBandwidth);
1939         out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1940       }
1941       else
1942       {
1943         GNUNET_log(GNUNET_ERROR_TYPE_INFO,
1944             _("Outbound quota configure for network `%s' is %llu\n"),
1945             network_str[c], out_dest[c]);
1946       }
1947       GNUNET_free(quota_out_str);
1948     }
1949     else
1950     {
1951       GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
1952           _("No outbound quota configured for network `%s', assigning default bandwidth %llu\n"),
1953           network_str[c], GNUNET_ATS_DefaultBandwidth);
1954       out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1955     }
1956
1957     /* quota in */
1958     if (GNUNET_OK
1959         == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", entry_in,
1960             &quota_in_str))
1961     {
1962       res = GNUNET_NO;
1963       if (0 == strcmp (quota_in_str, GNUNET_ATS_MaxBandwidthString))
1964       {
1965         in_dest[c] = GNUNET_ATS_MaxBandwidth;
1966         res = GNUNET_YES;
1967       }
1968       if ((GNUNET_NO == res)
1969           && (GNUNET_OK
1970               == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, &in_dest[c])))
1971         res = GNUNET_YES;
1972       if ((GNUNET_NO == res)
1973           && (GNUNET_OK
1974               == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_in,
1975                   &in_dest[c])))
1976         res = GNUNET_YES;
1977
1978       if (GNUNET_NO == res)
1979       {
1980         GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
1981             _("Could not load quota for network `%s':  `%s', assigning default bandwidth %llu\n"),
1982             network_str[c], quota_in_str, GNUNET_ATS_DefaultBandwidth);
1983         in_dest[c] = GNUNET_ATS_DefaultBandwidth;
1984       }
1985       else
1986       {
1987         GNUNET_log(GNUNET_ERROR_TYPE_INFO,
1988             _("Inbound quota configured for network `%s' is %llu\n"),
1989             network_str[c], in_dest[c]);
1990       }
1991       GNUNET_free(quota_in_str);
1992     }
1993     else
1994     {
1995       GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
1996           _("No outbound quota configure for network `%s', assigning default bandwidth %llu\n"),
1997           network_str[c], GNUNET_ATS_DefaultBandwidth);
1998       out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1999     }
2000     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
2001         "Loaded quota for network `%s' (in/out): %llu %llu\n", network_str[c],
2002         in_dest[c], out_dest[c]);
2003     GNUNET_free(entry_out);
2004     GNUNET_free(entry_in);
2005   }
2006   return GNUNET_ATS_NetworkTypeCount;
2007 }
2008
2009 /**
2010  * Callback for solver to notify about assignment changes
2011  *
2012  * @param cls the GAS_Addresses_Handle
2013  * @param address the address with changes
2014  */
2015 static void
2016 bandwidth_changed_cb (void *cls, struct ATS_Address *address)
2017 {
2018   struct GAS_Addresses_Handle *handle = cls;
2019   struct GAS_Addresses_Suggestion_Requests *cur;
2020
2021   GNUNET_assert(handle != NULL);
2022   GNUNET_assert(address != NULL);
2023
2024   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
2025       "Bandwidth assignment changed for peer %s \n",
2026       GNUNET_i2s (&address->peer));
2027
2028   /* Notify performance clients about changes to address */
2029   GAS_performance_notify_all_clients (&address->peer, address->plugin,
2030       address->addr, address->addr_len, address->session_id, address->atsi,
2031       address->atsi_count, address->assigned_bw_out, address->assigned_bw_in);
2032   cur = handle->pending_requests_head;
2033   while (NULL != cur)
2034   {
2035     if (0 == memcmp (&address->peer, &cur->id, sizeof(cur->id)))
2036       break; /* we have an address request pending*/
2037     cur = cur->next;
2038   }
2039   if (NULL == cur)
2040   {
2041     GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Nobody is interested in peer `%s' :(\n",
2042         GNUNET_i2s (&address->peer));
2043     return;
2044   }
2045
2046   if ((0 == ntohl (address->assigned_bw_in.value__))
2047       && (0 == ntohl (address->assigned_bw_out.value__)))
2048   {
2049     GNUNET_log(GNUNET_ERROR_TYPE_INFO,
2050         "Telling transport to disconnect peer `%s'\n",
2051         GNUNET_i2s (&address->peer));
2052   }
2053   else
2054   {
2055     GNUNET_log(GNUNET_ERROR_TYPE_INFO,
2056         "Sending bandwidth update for peer `%s': %llu %llu\n",
2057         GNUNET_i2s (&address->peer), address->assigned_bw_out,
2058         address->assigned_bw_out);
2059   }
2060
2061   /* *Notify scheduling clients about suggestion */
2062   GAS_scheduling_transmit_address_suggestion (&address->peer, address->plugin,
2063       address->addr, address->addr_len, address->session_id, address->atsi,
2064       address->atsi_count, address->assigned_bw_out, address->assigned_bw_in);
2065 }
2066
2067 /**
2068  * Initialize address subsystem. The addresses subsystem manages the addresses
2069  * known and current performance information. It has a solver component
2070  * responsible for the resource allocation. It tells the solver about changes
2071  * and receives updates when the solver changes the resource allocation.
2072  *
2073  * @param cfg configuration to use
2074  * @param stats the statistics handle to use
2075  * @return an address handle
2076  */
2077 struct GAS_Addresses_Handle *
2078 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
2079     const struct GNUNET_STATISTICS_Handle *stats)
2080 {
2081   struct GAS_Addresses_Handle *ah;
2082   unsigned long long quotas_in[GNUNET_ATS_NetworkTypeCount];
2083   unsigned long long quotas_out[GNUNET_ATS_NetworkTypeCount];
2084   char *mode_str;
2085   char *plugin_short;
2086   int c;
2087
2088   ah = GNUNET_malloc (sizeof (struct GAS_Addresses_Handle));
2089   ah->running = GNUNET_NO;
2090
2091   ah->stat = (struct GNUNET_STATISTICS_Handle *) stats;
2092   /* Initialize the addresses database */
2093   ah->addresses = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
2094   ah->pref_clients = 0;
2095   GNUNET_assert(NULL != ah->addresses);
2096
2097   /* Figure out configured solution method */
2098   plugin_short = NULL;
2099   if (GNUNET_SYSERR
2100       == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", "MODE", &mode_str))
2101   {
2102     GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
2103         "No resource assignment method configured, using proportional approach\n");
2104     ah->ats_mode = MODE_PROPORTIONAL;
2105   }
2106   else
2107   {
2108     for (c = 0; c < strlen (mode_str); c++)
2109       mode_str[c] = toupper (mode_str[c]);
2110     if (0 == strcmp (mode_str, "PROPORTIONAL"))
2111     {
2112       ah->ats_mode = MODE_PROPORTIONAL;
2113       plugin_short = "proportional";
2114     }
2115     else if (0 == strcmp (mode_str, "MLP"))
2116     {
2117       ah->ats_mode = MODE_MLP;
2118       plugin_short = "mlp";
2119 #if !HAVE_LIBGLPK
2120       GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
2121           "Assignment method `%s' configured, but GLPK is not available, please install \n",
2122           mode_str);
2123       ah->ats_mode = MODE_PROPORTIONAL;
2124       plugin_short = "proportional";
2125 #endif
2126     }
2127     else if (0 == strcmp (mode_str, "RIL"))
2128     {
2129       ah->ats_mode = MODE_RIL;
2130       plugin_short = "ril";
2131     }
2132     else
2133     {
2134       GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
2135           "Invalid resource assignment method `%s' configured, using proportional approach\n",
2136           mode_str);
2137       ah->ats_mode = MODE_PROPORTIONAL;
2138       plugin_short = "proportional";
2139     }
2140     GNUNET_free(mode_str);
2141   }
2142
2143   load_quotas (cfg, quotas_out, quotas_in, GNUNET_ATS_NetworkTypeCount);
2144   ah->env.info_cb = &solver_info_cb;
2145   ah->env.info_cb_cls = ah;
2146   ah->env.bandwidth_changed_cb = &bandwidth_changed_cb;
2147   ah->env.bw_changed_cb_cls = ah;
2148   ah->env.get_preferences = &get_preferences_cb;
2149   ah->env.get_preference_cls = ah;
2150   ah->env.get_property = &get_property_cb;
2151   ah->env.get_property_cls = ah;
2152   ah->env.cfg = cfg;
2153   ah->env.stats = stats;
2154   ah->env.addresses = ah->addresses;
2155
2156   ah->env.network_count = GNUNET_ATS_NetworkTypeCount;
2157   int networks[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
2158   for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
2159   {
2160     ah->env.networks[c] = networks[c];
2161     ah->env.out_quota[c] = quotas_out[c];
2162     ah->env.in_quota[c] = quotas_in[c];
2163   }
2164
2165   GNUNET_asprintf (&ah->plugin, "libgnunet_plugin_ats_%s", plugin_short);
2166   GNUNET_log(GNUNET_ERROR_TYPE_INFO, _("Initializing solver `%s '`%s'\n"), plugin_short, ah->plugin);
2167   if  (NULL == (ah->solver = GNUNET_PLUGIN_load (ah->plugin, &ah->env)))
2168   {
2169     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Failed to initialize solver `%s'!\n"), ah->plugin);
2170     return NULL;
2171   }
2172
2173   GNUNET_assert (NULL != ah->env.sf.s_add);
2174   GNUNET_assert (NULL != ah->env.sf.s_address_update_inuse);
2175   GNUNET_assert (NULL != ah->env.sf.s_address_update_property);
2176   GNUNET_assert (NULL != ah->env.sf.s_address_update_session);
2177   GNUNET_assert (NULL != ah->env.sf.s_address_update_network);
2178   GNUNET_assert (NULL != ah->env.sf.s_get);
2179   GNUNET_assert (NULL != ah->env.sf.s_get_stop);
2180   GNUNET_assert (NULL != ah->env.sf.s_pref);
2181   GNUNET_assert (NULL != ah->env.sf.s_feedback);
2182   GNUNET_assert (NULL != ah->env.sf.s_del);
2183   GNUNET_assert (NULL != ah->env.sf.s_bulk_start);
2184   GNUNET_assert (NULL != ah->env.sf.s_bulk_stop);
2185
2186
2187   GAS_normalization_start (&normalized_preference_changed_cb, ah,
2188       &normalized_property_changed_cb, ah);
2189
2190   if (NULL == ah->solver)
2191   {
2192     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Failed to initialize solver!\n"));
2193     GNUNET_free(ah);
2194     return NULL ;
2195   }
2196   /* up and running */
2197   ah->running = GNUNET_YES;
2198
2199   GNUNET_STATISTICS_set (ah->stat, "# addresses",
2200       GNUNET_CONTAINER_multipeermap_size (ah->addresses), GNUNET_NO);
2201
2202   return ah;
2203 }
2204
2205 /**
2206  * Destroy all addresses iterator
2207  *
2208  * @param cls NULL
2209  * @param key peer identity (unused)
2210  * @param value the 'struct ATS_Address' to free
2211  * @return #GNUNET_OK (continue to iterate)
2212  */
2213 static int
2214 destroy_all_address_it (void *cls,
2215                         const struct GNUNET_PeerIdentity *key,
2216                         void *value)
2217 {
2218   struct GAS_Addresses_Handle *handle = cls;
2219   struct ATS_Address *aa = value;
2220
2221   /* Remove */
2222   GNUNET_assert(GNUNET_YES ==
2223                 GNUNET_CONTAINER_multipeermap_remove (handle->addresses, key, value));
2224   /* Notify */
2225   handle->env.sf.s_del (handle->solver, aa, GNUNET_NO);
2226   /* Destroy */
2227   free_address (aa);
2228
2229   return GNUNET_OK;
2230 }
2231
2232
2233 /**
2234  * Remove all addresses
2235  *
2236  * @param handle the address handle to use
2237  */
2238 void
2239 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle)
2240 {
2241   if (GNUNET_NO == handle->running)
2242     return;
2243
2244   GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Destroying all addresses\n");
2245   handle->env.sf.s_bulk_start (handle->solver);
2246   if (handle->addresses != NULL )
2247     GNUNET_CONTAINER_multipeermap_iterate (handle->addresses,
2248                                            &destroy_all_address_it,
2249                                            handle);
2250   handle->env.sf.s_bulk_start (handle->solver);
2251 }
2252
2253
2254 /**
2255  * Shutdown address subsystem.
2256  *
2257  * @param handle the address handle to shutdown
2258  */
2259 void
2260 GAS_addresses_done (struct GAS_Addresses_Handle *handle)
2261 {
2262   struct GAS_Addresses_Suggestion_Requests *cur;
2263   struct GAS_Addresses_Preference_Clients *pcur;
2264
2265   GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Shutting down addresses\n");
2266   GNUNET_assert(NULL != handle);
2267   GAS_addresses_destroy_all (handle);
2268   handle->running = GNUNET_NO;
2269   GNUNET_CONTAINER_multipeermap_destroy (handle->addresses);
2270   handle->addresses = NULL;
2271   while (NULL != (cur = handle->pending_requests_head))
2272   {
2273     GNUNET_CONTAINER_DLL_remove(handle->pending_requests_head, handle->pending_requests_tail, cur);
2274     GNUNET_free(cur);
2275   }
2276
2277   while (NULL != (pcur = handle->preference_clients_head))
2278   {
2279     GNUNET_CONTAINER_DLL_remove (handle->preference_clients_head,
2280         handle->preference_clients_tail, pcur);
2281     GNUNET_assert (handle->pref_clients > 0);
2282     handle->pref_clients --;
2283     GNUNET_STATISTICS_set (handle->stat, "# active performance clients", handle->pref_clients, GNUNET_NO);
2284     GNUNET_free (pcur);
2285   }
2286
2287   GNUNET_PLUGIN_unload (handle->plugin, handle->solver);
2288   GNUNET_free (handle->plugin);
2289   GNUNET_free(handle);
2290   /* Stop configured solution method */
2291   GAS_normalization_stop ();
2292 }
2293
2294
2295 struct PeerIteratorContext
2296 {
2297   GNUNET_ATS_Peer_Iterator it;
2298   void *it_cls;
2299   struct GNUNET_CONTAINER_MultiPeerMap *peers_returned;
2300 };
2301
2302
2303 /**
2304  * Iterator to iterate over all peers
2305  *
2306  * @param cls a PeerIteratorContext
2307  * @param key the peer id
2308  * @param value the ATS_address
2309  * @return #GNUNET_OK to continue
2310  */
2311 static int
2312 peer_it (void *cls,
2313          const struct GNUNET_PeerIdentity *key,
2314          void *value)
2315 {
2316   struct PeerIteratorContext *ip_ctx = cls;
2317
2318   if (GNUNET_NO ==
2319       GNUNET_CONTAINER_multipeermap_contains (ip_ctx->peers_returned, key))
2320   {
2321     GNUNET_CONTAINER_multipeermap_put (ip_ctx->peers_returned, key, NULL,
2322                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
2323     ip_ctx->it (ip_ctx->it_cls, key);
2324   }
2325
2326   return GNUNET_OK;
2327 }
2328
2329 /**
2330  * Return information all peers currently known to ATS
2331  *
2332  * @param handle the address handle to use
2333  * @param p_it the iterator to call for every peer
2334  * @param p_it_cls the closure for the iterator
2335  */
2336 void
2337 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
2338     GNUNET_ATS_Peer_Iterator p_it, void *p_it_cls)
2339 {
2340   struct PeerIteratorContext ip_ctx;
2341   unsigned int size;
2342
2343   if (NULL == p_it)
2344     return;
2345   GNUNET_assert(NULL != handle->addresses);
2346
2347   size = GNUNET_CONTAINER_multipeermap_size (handle->addresses);
2348   if (0 != size)
2349   {
2350     ip_ctx.it = p_it;
2351     ip_ctx.it_cls = p_it_cls;
2352     ip_ctx.peers_returned = GNUNET_CONTAINER_multipeermap_create (size,
2353                                                                   GNUNET_NO);
2354     GNUNET_CONTAINER_multipeermap_iterate (handle->addresses,
2355                                            &peer_it,
2356                                            &ip_ctx);
2357     GNUNET_CONTAINER_multipeermap_destroy (ip_ctx.peers_returned);
2358   }
2359   p_it (p_it_cls, NULL );
2360 }
2361
2362 struct PeerInfoIteratorContext
2363 {
2364   GNUNET_ATS_PeerInfo_Iterator it;
2365   void *it_cls;
2366 };
2367
2368
2369 /**
2370  * Iterator to iterate over a peer's addresses
2371  *
2372  * @param cls a `struct PeerInfoIteratorContext`
2373  * @param key the peer id
2374  * @param value the `struct ATS_address`
2375  * @return #GNUNET_OK to continue
2376  */
2377 static int
2378 peerinfo_it (void *cls,
2379              const struct GNUNET_PeerIdentity *key,
2380              void *value)
2381 {
2382   struct PeerInfoIteratorContext *pi_ctx = cls;
2383   struct ATS_Address *addr = value;
2384
2385   if (NULL != pi_ctx->it)
2386   {
2387     pi_ctx->it (pi_ctx->it_cls, &addr->peer, addr->plugin, addr->addr,
2388         addr->addr_len, addr->active, addr->atsi, addr->atsi_count,
2389         addr->assigned_bw_out, addr->assigned_bw_in);
2390   }
2391   return GNUNET_YES;
2392 }
2393
2394
2395 /**
2396  * Return information all peers currently known to ATS
2397  *
2398  * @param handle the address handle to use
2399  * @param peer the respective peer
2400  * @param pi_it the iterator to call for every peer
2401  * @param pi_it_cls the closure for the iterator
2402  */
2403 void
2404 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
2405     const struct GNUNET_PeerIdentity *peer, GNUNET_ATS_PeerInfo_Iterator pi_it,
2406     void *pi_it_cls)
2407 {
2408   struct PeerInfoIteratorContext pi_ctx;
2409   struct GNUNET_BANDWIDTH_Value32NBO zero_bw;
2410
2411   GNUNET_assert(NULL != peer);
2412   GNUNET_assert(NULL != handle->addresses);
2413   if (NULL == pi_it)
2414     return; /* does not make sense without callback */
2415
2416   zero_bw = GNUNET_BANDWIDTH_value_init (0);
2417   pi_ctx.it = pi_it;
2418   pi_ctx.it_cls = pi_it_cls;
2419
2420   GNUNET_CONTAINER_multipeermap_get_multiple (handle->addresses,
2421                                               peer,
2422                                               &peerinfo_it, &pi_ctx);
2423
2424   if (NULL != pi_it)
2425     pi_it (pi_it_cls, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, zero_bw,
2426         zero_bw);
2427
2428 }
2429
2430 /* end of gnunet-service-ats_addresses.c */