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