src/ats/gnunet-service-ats_addresses.c

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