src/ats/gnunet-service-ats_addresses.h

   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.h
  23  * @brief ats service address management
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #ifndef GNUNET_SERVICE_ATS_ADDRESSES_H
  28 #define GNUNET_SERVICE_ATS_ADDRESSES_H
  29
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_ats_service.h"
  32 #include "gnunet_statistics_service.h"
  33 #include "ats.h"
  34
  35 /**
  36  * NOTE: Do not change this documentation. This documentation is based on
  37  * gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
  38  * use build_txt.sh to generate plaintext output
  39  *
  40  *   1 ATS addresses : ATS address management
  41  *
  42  *    This ATS addresses ("addresses") component manages the addresses known to
  43  *    ATS service and suggests addresses to transport service when it is
  44  *    interested in address suggestion for a peer. ATS addresses also
  45  *    instantiates the bandwidth assignment mechanism (solver), notifies it
  46  *    about changes to addresses and forwards changes to bandwidth assignments
  47  *    to transport, depending if transport is interested in this change.
  48  *
  49  *     1.1 Input data
  50  *
  51  *       1.1.1 Addresses
  52  *
  53  *    Addresses are added by specifying peer ID, plugin, address, address length
  54  *    and session, if available. ATS information can be specified if available.
  55  *
  56  *       1.1.2 Networks
  57  *
  58  *    ATS specifies a fix set of networks an address can belong to. For each
  59  *    network an inbound and outbound quota will be specified. The available
  60  *    networks and addtional helper varaibles are defined in
  61  *    gnunet_ats_service.h. At the moment 5 networks are defined:
  62  *      * GNUNET_ATS_NET_UNSPECIFIED
  63  *      * GNUNET_ATS_NET_LOOPBACK
  64  *      * GNUNET_ATS_NET_LAN
  65  *      * GNUNET_ATS_NET_WAN
  66  *      * GNUNET_ATS_NET_WLAN
  67  *
  68  *    The total number of networks defined is stored in
  69  *    GNUNET_ATS_NetworkTypeCount GNUNET_ATS_NetworkType can be used array
  70  *    initializer for an int array, while GNUNET_ATS_NetworkType is an
  71  *    initializer for a char array containing a string description of all
  72  *    networks
  73  *
  74  *       1.1.3 Quotas
  75  *
  76  *    An inbound and outbound quota for each of the networks mentioned in 1.1.2
  77  *    is loaded from ats configuration during initialization. This quota defines
  78  *    to total amount of inbound and outbound traffic allowed for a specific
  79  *    network. The configuration values used are in section ats:
  80  *      * "NETWORK"_QUOTA_IN = <value>
  81  *      * "NETWORK"_QUOTA_IN = <value>
  82  *
  83  *    You can specify quotas by setting the <value> to a:
  84  *      * unrestricted: unlimited
  85  *      * number of bytes: e.g. 10240
  86  *      * fancy value: e.g. 64 Kib
  87  *
  88  *    unlimited is defined as GNUNET_ATS_MaxBandwidthString and equivalent to
  89  *    the value GNUNET_ATS_MaxBandwidth Important predefined values for quotas
  90  *    are:
  91  *      * GNUNET_ATS_DefaultBandwidth: 65536
  92  *      * GNUNET_ATS_MaxBandwidth: UINT32_MAX
  93  *      * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT: 1024
  94  *
  95  *    Details of loading quotas and default values will be described on
  96  *
  97  *       1.1.4 Preference values
  98  *
  99  *     1.2 Data structures used
 100  *
 101  *    Addresse uses struct ATS_Address for each address. The structs are stored
 102  *    in a linked list and provides a pointer void *solver_information for the
 103  *    solver to store address specific information. It provides the int values
 104  *    active which is set to GNUNET_YES if the address is select for transport
 105  *    use and used, representing that transport service is actively using this
 106  *    address. Address information are stored in peer, addr, addr_len, plugin.
 107  *
 108  *     1.3 Initialization
 109  *
 110  *    During initialization a hashmap to store addresses is created. The quotas
 111  *    for all networks defined for ATS are loaded from configuration. For each
 112  *    network first the logic will check if the string
 113  *    GNUNET_ATS_MaxBandwidthString is configured, if not it will try to convert
 114  *    the configured value as a fancy size and if this fails it will try to use
 115  *    it as a value_number. If no configuration value is found it will assign
 116  *    GNUNET_ATS_DefaultBandwidth. The most important step is to load the
 117  *    configured solver using configuration "[ats]:MODE". Current solvers are
 118  *    MODE_SIMPLISTIC, MODE_MLP. Interaction is done using a solver API
 119  *
 120  *     1.4 Solver API
 121  *
 122  *    Solver functions:
 123  *      * s_init: init the solver with required information
 124  *      * s_add: add a new address
 125  *      * s_update: update ATS values or session for an address
 126  *      * s_get: get prefered address for a peer
 127  *      * s_del: delete an address
 128  *      * s_pref: change preference value for a peer
 129  *      * s_done: shutdown solver
 130  *
 131  *    Callbacks: addresses provides a bandwidth_changed_cb callback to the
 132  *    solver which is called when bandwidth assigned to peer has changed
 133  *
 134  *     1.5 Shutdown
 135  *
 136  *    During shutdown all addresses are freed and the solver told to shutdown
 137  *
 138  *     1.6 Addresses and sessions
 139  *
 140  *    Addresses consist of the address itself and a numerical session. When a
 141  *    new address without a session is added it has no session, so it gets
 142  *    session 0 assigned. When an address with a session is added and an address
 143  *    object with session 0 is found, this object is updated with the session
 144  *    otherwise a new address object with this session assigned is created.
 145  *
 146  *       1.6.1 Terminology
 147  *
 148  *    Addresses a1,a2 with session s1, s2 are "exact" if:
 149  *    (a1 == a2)&&(s1 == s2)
 150  *    Addresses a1,a2 with session s1, s2 are "equivalent" if:
 151  *    (a1 == a2)&&((s1 == s2)||(s1 == 0)||(s2 == 0)
 152  *
 153  *     1.7 Address management
 154  *
 155  *    Transport service notifies ATS about changes to the addresses known to
 156  *    him.
 157  *
 158  *       1.7.1 Adding an address
 159  *
 160  *    When transport learns a new address it tells ATS and ATS is telling
 161  *    addresses about it using GAS_address_add. If not known to addresses it
 162  *    creates a new address object and calls solver's s_add. ATS information are
 163  *    deserialized and solver is notified about the session and ATS information
 164  *    using s_update.
 165  *
 166  *       1.7.2 Updating an address
 167  *
 168  *    Addresses does an lookup up for the existing address with the given
 169  *    session. If disassembles included ATS information and notifies the solver
 170  *    using s_update about the update.
 171  *
 172  *       1.7.3 Deleting an address
 173  *
 174  *    Addresses does an lookup for the exact address and session and if removes
 175  *    this address. If session != 0 the session is set to 0 and the address is
 176  *    kept. If session == 0, the addresses is removed.
 177  *
 178  *       1.7.4 Requesting an address suggestion
 179  *
 180  *    The address client issues a request address message to be notified about
 181  *    address suggestions for a specific peer. Addresses asks the solver with
 182  *    s_get. If no address is available, it will not send a response, otherwise
 183  *    it will respond with the choosen address.
 184  *
 185  *       1.7.5 Address suggestions
 186  *
 187  *    Addresses will notify the client automatically on any bandwidth_changed_cb
 188  *    by the solver if a address suggestion request is pending. If no address is
 189  *    available it will not respond at all If the client is not interested
 190  *    anymore, it has to cancel the address suggestion request.
 191  *
 192  *       1.7.6 Suggestions blocks and reset
 193  *
 194  *    After suggesting an address it is blocked for ATS_BLOCKING_DELTA sec. to
 195  *    prevent the client from being thrashed. If the client requires immediately
 196  *    it can reset this block using GAS_addresses_handle_backoff_reset.
 197  *
 198  *       1.7.7 Marking address in use
 199  *
 200  *    The client can notify addresses that it successfully uses an address and
 201  *    wants this address to be kept by calling GSA_address_in_use. Adresses will
 202  *    mark the address as used an notify the solver about the use.
 203  *
 204  *       1.7.8 Address lifecycle
 205  *
 206  *      * (add address)
 207  *      * (updated address) || (address in use)
 208  *      * (delete address)
 209  *
 210  *     1.8 Bandwidth assignment
 211  *
 212  *    The addresses are used to perform resource allocation operations. ATS
 213  *    addresses takes care of instantiating the solver configured and notifies
 214  *    the respective solver about address changes and receives changes to the
 215  *    bandwidth assignment from the solver. The current bandwidth assignment is
 216  *    sent to transport. The specific solvers will be described in the specific
 217  *    section.
 218  *
 219  *     1.9 Changing peer preferences
 220  *
 221  *    The bandwidth assigned to a peer can be influenced by setting a preference
 222  *    for a peer. The prefernce will be given to to the solver with s_pref which
 223  *    has to take care of the preference value
 224
 225  */
 226
 227
 228 /*
 229  * How long will address suggestions blocked after a suggestion
 230  */
 231 #define ATS_BLOCKING_DELTA GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 100)
 232
 233 struct GAS_Addresses_Handle;
 234
 235 /**
 236  * Address with additional information
 237  */
 238 struct ATS_Address
 239 {
 240   /**
 241    * Next element in DLL
 242    */
 243   struct ATS_Address *next;
 244
 245   /**
 246    * Previous element in DLL
 247    */
 248   struct ATS_Address *prev;
 249
 250   /**
 251    * Peer ID
 252    */
 253   struct GNUNET_PeerIdentity peer;
 254
 255   /**
 256    * Session ID, 0 if no session is given
 257    */
 258   uint32_t session_id;
 259
 260   /**
 261    * Address
 262    */
 263   const void *addr;
 264
 265   /**
 266    * Address length
 267    */
 268   size_t addr_len;
 269
 270   /**
 271    * Plugin name
 272    */
 273   char *plugin;
 274
 275   /**
 276    * Solver specific information for this address
 277    */
 278   void *solver_information;
 279
 280   /**
 281    * ATS performance information for this address
 282    */
 283   struct GNUNET_ATS_Information *atsi;
 284
 285   /**
 286    * ATS performance information for this address
 287    */
 288   uint32_t atsi_count;
 289
 290 #if 0
 291   /* CHECK USAGE */
 292   struct GNUNET_TIME_Relative atsp_latency;
 293
 294   /* CHECK USAGE */
 295   struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_in;
 296
 297   /* CHECK USAGE */
 298   struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_out;
 299
 300
 301   /* CHECK USAGE */
 302   uint32_t atsp_distance;
 303
 304   /* CHECK USAGE */
 305   uint32_t atsp_cost_wan;
 306
 307   /* CHECK USAGE */
 308   uint32_t atsp_cost_lan;
 309
 310   /* CHECK USAGE */
 311   uint32_t atsp_cost_wlan;
 312
 313   /* CHECK USAGE */
 314   uint32_t atsp_network_type;
 315 #endif
 316   /**
 317    * Inbound bandwidth assigned by solver in NBO
 318    */
 319   struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_in;
 320
 321   /**
 322    * Outbound bandwidth assigned by solver in NBO
 323    */
 324   struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_out;
 325
 326   /**
 327    * Blocking interval
 328    */
 329   struct GNUNET_TIME_Relative block_interval;
 330
 331   /**
 332    * Time when address can be suggested again
 333    */
 334   struct GNUNET_TIME_Absolute blocked_until;
 335
 336   /**
 337    * Is this the active address for this peer?
 338    */
 339   int active;
 340
 341   /**
 342    * Is this the address for this peer in use?
 343    */
 344   int used;
 345 };
 346
 347
 348 /**
 349  * Callback to call from solver when bandwidth for address has changed
 350  *
 351  * @param address the with changed bandwidth assigned
 352  */
 353
 354 typedef void
 355  (*GAS_bandwidth_changed_cb) (void *cls, struct ATS_Address *address);
 356
 357 typedef const double *
 358  (*GAS_get_preferences) (void *cls, const struct GNUNET_PeerIdentity *id);
 359
 360
 361 /*
 362  * Solver API
 363  * ----------
 364  */
 365
 366 /**
 367  * Init the simplistic problem solving component
 368  *
 369  * Quotas:
 370  * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
 371  * out_quota[i] contains outbound quota for network type i
 372  * in_quota[i] contains inbound quota for network type i
 373  *
 374  * Example
 375  * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
 376  * network[2]   == GNUNET_ATS_NET_LAN
 377  * out_quota[2] == 65353
 378  * in_quota[2]  == 65353
 379  *
 380  * @param cfg configuration handle
 381  * @param stats the GNUNET_STATISTICS handle
 382  * @param network array of GNUNET_ATS_NetworkType with length dest_length
 383  * @param out_quota array of outbound quotas
 384  * @param in_quota array of outbound quota
 385  * @param bw_changed_cb callback to call when assigned changes
 386  * @return handle for the solver on success, NULL on fail
 387  */
 388 typedef void *
 389  (*GAS_solver_init) (const struct GNUNET_CONFIGURATION_Handle *cfg,
 390                      const struct GNUNET_STATISTICS_Handle *stats,
 391                      int *network,
 392                      unsigned long long *out_quota,
 393                      unsigned long long *in_quota,
 394                      int dest_length,
 395                      GAS_bandwidth_changed_cb bw_changed_cb,
 396                      void *bw_changed_cb_cls,
 397                      GAS_get_preferences get_preference,
 398                      void *get_preference_cls);
 399
 400
 401 /**
 402  * Change the preference for a peer
 403  *
 404  * @param handle the solver handle
 405  * @param client the client sending this request
 406  * @param peer the peer id
 407  * @param kind the preference kind to change
 408  * @param score the new preference score
 409  * @param pref_rel the normalized preference value for this kind over all clients
 410  */
 411 typedef void
 412 (*GAS_solver_address_change_preference) (void *solver,
 413                                                                                                                                                                  struct GNUNET_CONTAINER_MultiHashMap *addresses,
 414                                                                                                                                                                  const struct GNUNET_PeerIdentity *peer,
 415                                                                                                                                                                  enum GNUNET_ATS_PreferenceKind kind,
 416                                                                                                                                                                  double pref_rel);
 417
 418 /**
 419  * Add a single address within a network to the solver
 420  *
 421  * @param solver the solver Handle
 422  * @param addresses the address hashmap containing all addresses
 423  * @param address the address to add
 424  * @param network network type of this address
 425  */
 426 typedef void
 427 (*GAS_solver_address_add) (void *solver,
 428                                                                                                                 struct GNUNET_CONTAINER_MultiHashMap *addresses,
 429                                                                                                                 struct ATS_Address *address,
 430                                                                                                                 uint32_t network);
 431
 432
 433 /**
 434  * Delete an address or just the session from the solver
 435  *
 436  * @param solver the solver Handle
 437  * @param addresses the address hashmap containing all addresses
 438  * @param address the address to delete
 439  * @param session_only remove address or just session
 440  */
 441 typedef void
 442  (*GAS_solver_address_delete) (void *solver,
 443                                struct GNUNET_CONTAINER_MultiHashMap *addresses,
 444                                struct ATS_Address *address,
 445                                int session_only);
 446
 447 /**
 448  * Notify the solver about an update for an address
 449  *
 450  * @param solver the solver to use
 451  * @param addresses the address hashmap containing all addresses
 452  * @param address the address
 453  * @param session the previous session
 454  * @param in_use previous address used state: yes or no
 455  * @param atsi ats previous performance information
 456  * @param atsi_count previous number of ats performance information
 457  *
 458  */
 459 typedef void
 460 (*GAS_solver_address_update) (void *solver,
 461                               struct GNUNET_CONTAINER_MultiHashMap *addresses,
 462                               struct ATS_Address *address,
 463                               uint32_t prev_session,
 464                               int in_use,
 465                               const struct GNUNET_ATS_Information *prev_atsi,
 466                               uint32_t prev_atsi_count);
 467
 468
 469 /**
 470  * Get the prefered address for a peer from solver
 471  *
 472  * @param solver the solver to use
 473  * @param addresses the address hashmap containing all addresses
 474  * @param peer the peer
 475  */
 476 typedef const struct ATS_Address *
 477 (*GAS_solver_get_preferred_address) (void *solver,
 478                                      struct GNUNET_CONTAINER_MultiHashMap *addresses,
 479                                      const struct GNUNET_PeerIdentity *peer);
 480
 481
 482 /**
 483  * Stop getting the prefered address for a peer from solver
 484  *
 485  * @param solver the solver to use
 486  * @param addresses the address hashmap containing all addresses
 487  * @param peer the peer
 488  */
 489 typedef void
 490 (*GAS_solver_stop_get_preferred_address) (void *solver,
 491                                      struct GNUNET_CONTAINER_MultiHashMap *addresses,
 492                                      const struct GNUNET_PeerIdentity *peer);
 493
 494 /**
 495  * Shutdown solver
 496  *
 497  * @param solver the solver to shutdown
 498  */
 499
 500 typedef void
 501  (*GAS_solver_done) (void *solver);
 502
 503
 504 /**
 505  * Initialize address subsystem. The addresses subsystem manages the addresses
 506  * known and current performance information. It has a solver component
 507  * responsible for the resource allocation. It tells the solver about changes
 508  * and receives updates when the solver changes the ressource allocation.
 509  *
 510  * @param cfg configuration to use
 511  * @param stats the statistics handle to use
 512  * @return an address handle
 513  */
 514 struct GAS_Addresses_Handle *
 515 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 516                     const struct GNUNET_STATISTICS_Handle *stats);
 517
 518
 519 /**
 520  * Shutdown address subsystem.
 521  *
 522  * @param handle the address handle to shutdown
 523  */
 524 void
 525 GAS_addresses_done (struct GAS_Addresses_Handle *handle);
 526
 527
 528 /**
 529  * Add a new address for a peer.
 530  *
 531  * @param handle the address handle to use
 532  * @param peer peer
 533  * @param plugin_name transport plugin name
 534  * @param plugin_addr plugin address
 535  * @param plugin_addr_len length of the plugin address
 536  * @param session_id session id, can be 0
 537  * @param atsi performance information for this address
 538  * @param atsi_count number of performance information contained
 539  */
 540 void
 541 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
 542                    const struct GNUNET_PeerIdentity *peer,
 543                    const char *plugin_name,
 544                    const void *plugin_addr,
 545                    size_t plugin_addr_len,
 546                    uint32_t session_id,
 547                    const struct GNUNET_ATS_Information *atsi,
 548                    uint32_t atsi_count);
 549
 550
 551 /**
 552  * Notification about active use of an address.
 553  * in_use == GNUNET_YES:
 554  *      This address is used to maintain an active connection with a peer.
 555  * in_use == GNUNET_NO:
 556  *      This address is no longer used to maintain an active connection with a peer.
 557  *
 558  * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
 559  * before
 560  *
 561  * @param handle the address handle to use
 562  * @param peer peer
 563  * @param plugin_name transport plugin name
 564  * @param plugin_addr plugin address
 565  * @param plugin_addr_len length of the plugin address
 566  * @param session_id session id, can be 0
 567  * @param in_use GNUNET_YES if GNUNET_NO
 568  * @return GNUNET_SYSERR on failure (address unknown ...)
 569  */
 570 int
 571 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
 572                       const struct GNUNET_PeerIdentity *peer,
 573                       const char *plugin_name,
 574                       const void *plugin_addr,
 575                       size_t plugin_addr_len,
 576                       uint32_t session_id,
 577                       int in_use);
 578
 579
 580 /**
 581  * Update an address with a session or performance information for a peer.
 582  *
 583  * If an address was added without a session it will be updated with the
 584  * session
 585  *
 586  * @param handle the address handle to use
 587  * @param peer peer
 588  * @param plugin_name transport plugin name
 589  * @param plugin_addr plugin address
 590  * @param plugin_addr_len length of the plugin address
 591  * @param session_id session id, can be 0
 592  * @param atsi performance information for this address
 593  * @param atsi_count number of performance information contained
 594  */
 595 void
 596 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
 597                       const struct GNUNET_PeerIdentity *peer,
 598                       const char *plugin_name,
 599                       const void *plugin_addr,
 600                       size_t plugin_addr_len,
 601                       uint32_t session_id,
 602                       const struct GNUNET_ATS_Information *atsi,
 603                       uint32_t atsi_count);
 604
 605
 606 /**
 607  * Remove an address or just a session for a peer.
 608  *
 609  * @param handle the address handle to use
 610  * @param peer peer
 611  * @param plugin_name transport plugin name
 612  * @param plugin_addr plugin address
 613  * @param plugin_addr_len length of the plugin address
 614  * @param session_id session id, can be 0
 615  */
 616 void
 617 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
 618                        const struct GNUNET_PeerIdentity *peer,
 619                        const char *plugin_name,
 620                        const void *plugin_addr,
 621                        size_t plugin_addr_len,
 622                        uint32_t session_id);
 623
 624
 625 /**
 626  * Remove all addresses
 627  *
 628  * @param handle the address handle to use
 629  */
 630 void
 631 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle);
 632
 633
 634 /**
 635  * Request address suggestions for a peer
 636  *
 637  * @param handle the address handle
 638  * @param peer the peer id
 639  */
 640 void
 641 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
 642                                const struct GNUNET_PeerIdentity *peer);
 643
 644 /**
 645  * Cancel address suggestions for a peer
 646  *
 647  * @param handle the address handle
 648  * @param peer the peer id
 649  */
 650 void
 651 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
 652                                       const struct GNUNET_PeerIdentity *peer);
 653
 654
 655 /**
 656  * Reset suggestion backoff for a peer
 657  *
 658  * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
 659  * reset using this function
 660  *
 661  * @param handle the address handle
 662  * @param peer the peer id
 663  */
 664 void
 665 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
 666                                     const struct GNUNET_PeerIdentity *peer);
 667
 668
 669 /**
 670  * Change the preference for a peer
 671  *
 672  * @param handle the address handle
 673  * @param client the client sending this request
 674  * @param peer the peer id
 675  * @param kind the preference kind to change
 676  * @param score_abs the new preference score
 677  */
 678 void
 679 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
 680                                  void *client,
 681                                  const struct GNUNET_PeerIdentity *peer,
 682                                  enum GNUNET_ATS_PreferenceKind kind,
 683                                  float score_abs);
 684
 685
 686 /**
 687  * Iterator for GAS_addresses_iterate_peers
 688  *
 689  * @param p_it_cls closure
 690  * @param id the peer id
 691  */
 692 typedef void (*GNUNET_ATS_Peer_Iterator) (void *p_it_cls,
 693                                           const struct GNUNET_PeerIdentity *id);
 694
 695
 696 /**
 697  * Return all peers currently known to ATS
 698  *
 699  * @param handle the address handle to use
 700  * @param p_it the iterator to call for every peer
 701  * @param p_it_cls the closure for the iterator
 702  */
 703 void
 704 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
 705                              GNUNET_ATS_Peer_Iterator p_it,
 706                              void *p_it_cls);
 707
 708
 709 /**
 710  * Iterator for GAS_addresses_get_peer_info
 711  *
 712  * @param p_it_cls closure closure
 713  * @param id the peer id
 714  * @param plugin_name plugin name
 715  * @param plugin_addr address
 716  * @param plugin_addr_len address length
 717  * @param address_active is address actively used
 718  * @param atsi ats performance information
 719  * @param atsi_count number of ats performance elements
 720  * @param bandwidth_out current outbound bandwidth assigned to address
 721  * @param bandwidth_in current inbound bandwidth assigned to address
 722  */
 723 typedef void (*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
 724     const struct GNUNET_PeerIdentity *id,
 725     const char *plugin_name,
 726     const void *plugin_addr,
 727     size_t plugin_addr_len,
 728     const int address_active,
 729     const struct GNUNET_ATS_Information *atsi,
 730     uint32_t atsi_count,
 731     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 732     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
 733
 734
 735 /**
 736  * Return information all peers currently known to ATS
 737  *
 738  * @param handle the address handle to use
 739  * @param peer the respective peer
 740  * @param pi_it the iterator to call for every peer
 741  * @param pi_it_cls the closure for the iterator
 742  */
 743 void
 744 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
 745                              const struct GNUNET_PeerIdentity *peer,
 746                              GNUNET_ATS_PeerInfo_Iterator pi_it,
 747                              void *pi_it_cls);
 748
 749 #endif
 750
 751 /* end of gnunet-service-ats_addresses.h */