src/ats/gnunet-service-ats_addresses.c

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