src/ats/gnunet-service-ats_addresses.c

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