src/ats/gnunet-service-ats_addresses.c

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