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  * Information provided by ATS normalization
 238  */
 239 struct GAS_NormalizationInfo
 240 {
 241                 /**
 242                  * Next index to use in averaging queue
 243                  */
 244                 unsigned int avg_queue_index;
 245
 246                 /**
 247                  * Averaging queue
 248                  */
 249           uint32_t atsi_abs[GAS_normalization_queue_length];
 250
 251                 /**
 252                  * Averaged ATSI values from queue
 253                  */
 254                 uint32_t avg;
 255
 256                 /**
 257                  * Normalized values from queue to a range of values [1.0...2.0]
 258                  */
 259                 double norm;
 260 };
 261
 262 /**
 263  * Address with additional information
 264  */
 265 struct ATS_Address
 266 {
 267   /**
 268    * Next element in DLL
 269    */
 270   struct ATS_Address *next;
 271
 272   /**
 273    * Previous element in DLL
 274    */
 275   struct ATS_Address *prev;
 276
 277   /**
 278    * Peer ID
 279    */
 280   struct GNUNET_PeerIdentity peer;
 281
 282   /**
 283    * Session ID, 0 if no session is given
 284    */
 285   uint32_t session_id;
 286
 287   /**
 288    * Address
 289    */
 290   const void *addr;
 291
 292   /**
 293    * Address length
 294    */
 295   size_t addr_len;
 296
 297   /**
 298    * Plugin name
 299    */
 300   char *plugin;
 301
 302   /**
 303    * Solver specific information for this address
 304    */
 305   void *solver_information;
 306
 307   /**
 308    * ATS performance information for this address
 309    */
 310   struct GNUNET_ATS_Information *atsi;
 311
 312   /**
 313    * ATS performance information for this address
 314    */
 315   uint32_t atsi_count;
 316
 317 #if 0
 318   /* CHECK USAGE */
 319   struct GNUNET_TIME_Relative atsp_latency;
 320
 321   /* CHECK USAGE */
 322   struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_in;
 323
 324   /* CHECK USAGE */
 325   struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_out;
 326
 327
 328   /* CHECK USAGE */
 329   uint32_t atsp_distance;
 330
 331   /* CHECK USAGE */
 332   uint32_t atsp_cost_wan;
 333
 334   /* CHECK USAGE */
 335   uint32_t atsp_cost_lan;
 336
 337   /* CHECK USAGE */
 338   uint32_t atsp_cost_wlan;
 339
 340   /* CHECK USAGE */
 341   uint32_t atsp_network_type;
 342 #endif
 343   /**
 344    * Inbound bandwidth assigned by solver in NBO
 345    */
 346   struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_in;
 347
 348   /**
 349    * Outbound bandwidth assigned by solver in NBO
 350    */
 351   struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_out;
 352
 353   /**
 354    * Blocking interval
 355    */
 356   struct GNUNET_TIME_Relative block_interval;
 357
 358   /**
 359    * Time when address can be suggested again
 360    */
 361   struct GNUNET_TIME_Absolute blocked_until;
 362
 363   /**
 364    * Is this the active address for this peer?
 365    */
 366   int active;
 367
 368   /**
 369    * Is this the address for this peer in use?
 370    */
 371   int used;
 372
 373   /**
 374    * Normalized ATS performance information for this address
 375    * Each entry can be accessed using the GNUNET_ATS_QualityProperties avg_queue_index
 376    */
 377   struct GAS_NormalizationInfo atsin[GNUNET_ATS_QualityPropertiesCount];
 378 };
 379
 380
 381 /**
 382  * Callback to call from solver when bandwidth for address has changed
 383  *
 384  * @param address the with changed bandwidth assigned
 385  */
 386
 387 typedef void
 388  (*GAS_bandwidth_changed_cb) (void *cls, struct ATS_Address *address);
 389
 390 typedef const double *
 391  (*GAS_get_preferences) (void *cls, const struct GNUNET_PeerIdentity *id);
 392
 393
 394 /*
 395  * Solver API
 396  * ----------
 397  */
 398
 399 /**
 400  * Init the simplistic problem solving component
 401  *
 402  * Quotas:
 403  * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
 404  * out_quota[i] contains outbound quota for network type i
 405  * in_quota[i] contains inbound quota for network type i
 406  *
 407  * Example
 408  * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
 409  * network[2]   == GNUNET_ATS_NET_LAN
 410  * out_quota[2] == 65353
 411  * in_quota[2]  == 65353
 412  *
 413  * @param cfg configuration handle
 414  * @param stats the GNUNET_STATISTICS handle
 415  * @param network array of GNUNET_ATS_NetworkType with length dest_length
 416  * @param out_quota array of outbound quotas
 417  * @param in_quota array of outbound quota
 418  * @param bw_changed_cb callback to call when assigned changes
 419  * @return handle for the solver on success, NULL on fail
 420  */
 421 typedef void *
 422  (*GAS_solver_init) (const struct GNUNET_CONFIGURATION_Handle *cfg,
 423                      const struct GNUNET_STATISTICS_Handle *stats,
 424                      int *network,
 425                      unsigned long long *out_quota,
 426                      unsigned long long *in_quota,
 427                      int dest_length,
 428                      GAS_bandwidth_changed_cb bw_changed_cb,
 429                      void *bw_changed_cb_cls,
 430                      GAS_get_preferences get_preference,
 431                      void *get_preference_cls);
 432
 433
 434 /**
 435  * Change the preference for a peer
 436  *
 437  * @param handle the solver handle
 438  * @param client the client sending this request
 439  * @param peer the peer id
 440  * @param kind the preference kind to change
 441  * @param score the new preference score
 442  * @param pref_rel the normalized preference value for this kind over all clients
 443  */
 444 typedef void
 445 (*GAS_solver_address_change_preference) (void *solver,
 446                                                                                                                                                                  struct GNUNET_CONTAINER_MultiHashMap *addresses,
 447                                                                                                                                                                  const struct GNUNET_PeerIdentity *peer,
 448                                                                                                                                                                  enum GNUNET_ATS_PreferenceKind kind,
 449                                                                                                                                                                  double pref_rel);
 450
 451 typedef void
 452 (*GAS_solver_bulk_start) (void *solver);
 453
 454 typedef void
 455 (*GAS_solver_bulk_stop) (void *solver);
 456
 457 /**
 458  * Add a single address within a network to the solver
 459  *
 460  * @param solver the solver Handle
 461  * @param addresses the address hashmap containing all addresses
 462  * @param address the address to add
 463  * @param network network type of this address
 464  */
 465 typedef void
 466 (*GAS_solver_address_add) (void *solver,
 467                                                                                                                 struct GNUNET_CONTAINER_MultiHashMap *addresses,
 468                                                                                                                 struct ATS_Address *address,
 469                                                                                                                 uint32_t network);
 470
 471
 472 /**
 473  * Delete an address or just the session from the solver
 474  *
 475  * @param solver the solver Handle
 476  * @param addresses the address hashmap containing all addresses
 477  * @param address the address to delete
 478  * @param session_only remove address or just session
 479  */
 480 typedef void
 481  (*GAS_solver_address_delete) (void *solver,
 482                                struct GNUNET_CONTAINER_MultiHashMap *addresses,
 483                                struct ATS_Address *address,
 484                                int session_only);
 485
 486 /**
 487  * Notify the solver about an update for an address
 488  *
 489  * @param solver the solver to use
 490  * @param addresses the address hashmap containing all addresses
 491  * @param address the address
 492  * @param session the previous session
 493  * @param in_use previous address used state: yes or no
 494  * @param atsi ats previous performance information
 495  * @param atsi_count previous number of ats performance information
 496  *
 497  */
 498 typedef void
 499 (*GAS_solver_address_update) (void *solver,
 500                               struct GNUNET_CONTAINER_MultiHashMap *addresses,
 501                               struct ATS_Address *address,
 502                               uint32_t prev_session,
 503                               int in_use,
 504                               const struct GNUNET_ATS_Information *prev_atsi,
 505                               uint32_t prev_atsi_count);
 506
 507
 508 /**
 509  * Get the prefered address for a peer from solver
 510  *
 511  * @param solver the solver to use
 512  * @param addresses the address hashmap containing all addresses
 513  * @param peer the peer
 514  */
 515 typedef const struct ATS_Address *
 516 (*GAS_solver_get_preferred_address) (void *solver,
 517                                      struct GNUNET_CONTAINER_MultiHashMap *addresses,
 518                                      const struct GNUNET_PeerIdentity *peer);
 519
 520
 521 /**
 522  * Stop getting the prefered address for a peer from solver
 523  *
 524  * @param solver the solver to use
 525  * @param addresses the address hashmap containing all addresses
 526  * @param peer the peer
 527  */
 528 typedef void
 529 (*GAS_solver_stop_get_preferred_address) (void *solver,
 530                                      struct GNUNET_CONTAINER_MultiHashMap *addresses,
 531                                      const struct GNUNET_PeerIdentity *peer);
 532
 533 /**
 534  * Shutdown solver
 535  *
 536  * @param solver the solver to shutdown
 537  */
 538
 539 typedef void
 540  (*GAS_solver_done) (void *solver);
 541
 542
 543 /**
 544  * Initialize address subsystem. The addresses subsystem manages the addresses
 545  * known and current performance information. It has a solver component
 546  * responsible for the resource allocation. It tells the solver about changes
 547  * and receives updates when the solver changes the ressource allocation.
 548  *
 549  * @param cfg configuration to use
 550  * @param stats the statistics handle to use
 551  * @return an address handle
 552  */
 553 struct GAS_Addresses_Handle *
 554 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 555                     const struct GNUNET_STATISTICS_Handle *stats);
 556
 557
 558 /**
 559  * Shutdown address subsystem.
 560  *
 561  * @param handle the address handle to shutdown
 562  */
 563 void
 564 GAS_addresses_done (struct GAS_Addresses_Handle *handle);
 565
 566
 567 /**
 568  * Add a new address for a peer.
 569  *
 570  * @param handle the address handle to use
 571  * @param peer peer
 572  * @param plugin_name transport plugin name
 573  * @param plugin_addr plugin address
 574  * @param plugin_addr_len length of the plugin address
 575  * @param session_id session id, can be 0
 576  * @param atsi performance information for this address
 577  * @param atsi_count number of performance information contained
 578  */
 579 void
 580 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
 581                    const struct GNUNET_PeerIdentity *peer,
 582                    const char *plugin_name,
 583                    const void *plugin_addr,
 584                    size_t plugin_addr_len,
 585                    uint32_t session_id,
 586                    const struct GNUNET_ATS_Information *atsi,
 587                    uint32_t atsi_count);
 588
 589
 590 /**
 591  * Notification about active use of an address.
 592  * in_use == GNUNET_YES:
 593  *      This address is used to maintain an active connection with a peer.
 594  * in_use == GNUNET_NO:
 595  *      This address is no longer used to maintain an active connection with a peer.
 596  *
 597  * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
 598  * before
 599  *
 600  * @param handle the address handle to use
 601  * @param peer peer
 602  * @param plugin_name transport plugin name
 603  * @param plugin_addr plugin address
 604  * @param plugin_addr_len length of the plugin address
 605  * @param session_id session id, can be 0
 606  * @param in_use GNUNET_YES if GNUNET_NO
 607  * @return GNUNET_SYSERR on failure (address unknown ...)
 608  */
 609 int
 610 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
 611                       const struct GNUNET_PeerIdentity *peer,
 612                       const char *plugin_name,
 613                       const void *plugin_addr,
 614                       size_t plugin_addr_len,
 615                       uint32_t session_id,
 616                       int in_use);
 617
 618
 619 /**
 620  * Update an address with a session or performance information for a peer.
 621  *
 622  * If an address was added without a session it will be updated with the
 623  * session
 624  *
 625  * @param handle the address handle to use
 626  * @param peer peer
 627  * @param plugin_name transport plugin name
 628  * @param plugin_addr plugin address
 629  * @param plugin_addr_len length of the plugin address
 630  * @param session_id session id, can be 0
 631  * @param atsi performance information for this address
 632  * @param atsi_count number of performance information contained
 633  */
 634 void
 635 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
 636                       const struct GNUNET_PeerIdentity *peer,
 637                       const char *plugin_name,
 638                       const void *plugin_addr,
 639                       size_t plugin_addr_len,
 640                       uint32_t session_id,
 641                       const struct GNUNET_ATS_Information *atsi,
 642                       uint32_t atsi_count);
 643
 644
 645 /**
 646  * Remove an address or just a session for a peer.
 647  *
 648  * @param handle the address handle to use
 649  * @param peer peer
 650  * @param plugin_name transport plugin name
 651  * @param plugin_addr plugin address
 652  * @param plugin_addr_len length of the plugin address
 653  * @param session_id session id, can be 0
 654  */
 655 void
 656 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
 657                        const struct GNUNET_PeerIdentity *peer,
 658                        const char *plugin_name,
 659                        const void *plugin_addr,
 660                        size_t plugin_addr_len,
 661                        uint32_t session_id);
 662
 663
 664 /**
 665  * Remove all addresses
 666  *
 667  * @param handle the address handle to use
 668  */
 669 void
 670 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle);
 671
 672
 673 /**
 674  * Request address suggestions for a peer
 675  *
 676  * @param handle the address handle
 677  * @param peer the peer id
 678  */
 679 void
 680 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
 681                                const struct GNUNET_PeerIdentity *peer);
 682
 683 /**
 684  * Cancel address suggestions for a peer
 685  *
 686  * @param handle the address handle
 687  * @param peer the peer id
 688  */
 689 void
 690 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
 691                                       const struct GNUNET_PeerIdentity *peer);
 692
 693
 694 /**
 695  * Reset suggestion backoff for a peer
 696  *
 697  * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
 698  * reset using this function
 699  *
 700  * @param handle the address handle
 701  * @param peer the peer id
 702  */
 703 void
 704 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
 705                                     const struct GNUNET_PeerIdentity *peer);
 706
 707
 708 /**
 709  * Change the preference for a peer
 710  *
 711  * @param handle the address handle
 712  * @param client the client sending this request
 713  * @param peer the peer id
 714  * @param kind the preference kind to change
 715  * @param score_abs the new preference score
 716  */
 717 void
 718 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
 719                                  void *client,
 720                                  const struct GNUNET_PeerIdentity *peer,
 721                                  enum GNUNET_ATS_PreferenceKind kind,
 722                                  float score_abs);
 723
 724
 725 /**
 726  * Iterator for GAS_addresses_iterate_peers
 727  *
 728  * @param p_it_cls closure
 729  * @param id the peer id
 730  */
 731 typedef void (*GNUNET_ATS_Peer_Iterator) (void *p_it_cls,
 732                                           const struct GNUNET_PeerIdentity *id);
 733
 734
 735 /**
 736  * Return all peers currently known to ATS
 737  *
 738  * @param handle the address handle to use
 739  * @param p_it the iterator to call for every peer
 740  * @param p_it_cls the closure for the iterator
 741  */
 742 void
 743 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
 744                              GNUNET_ATS_Peer_Iterator p_it,
 745                              void *p_it_cls);
 746
 747
 748 /**
 749  * Iterator for GAS_addresses_get_peer_info
 750  *
 751  * @param p_it_cls closure closure
 752  * @param id the peer id
 753  * @param plugin_name plugin name
 754  * @param plugin_addr address
 755  * @param plugin_addr_len address length
 756  * @param address_active is address actively used
 757  * @param atsi ats performance information
 758  * @param atsi_count number of ats performance elements
 759  * @param bandwidth_out current outbound bandwidth assigned to address
 760  * @param bandwidth_in current inbound bandwidth assigned to address
 761  */
 762 typedef void (*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
 763     const struct GNUNET_PeerIdentity *id,
 764     const char *plugin_name,
 765     const void *plugin_addr,
 766     size_t plugin_addr_len,
 767     const int address_active,
 768     const struct GNUNET_ATS_Information *atsi,
 769     uint32_t atsi_count,
 770     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 771     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
 772
 773
 774 /**
 775  * Return information all peers currently known to ATS
 776  *
 777  * @param handle the address handle to use
 778  * @param peer the respective peer
 779  * @param pi_it the iterator to call for every peer
 780  * @param pi_it_cls the closure for the iterator
 781  */
 782 void
 783 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
 784                              const struct GNUNET_PeerIdentity *peer,
 785                              GNUNET_ATS_PeerInfo_Iterator pi_it,
 786                              void *pi_it_cls);
 787
 788 #endif
 789
 790 /* end of gnunet-service-ats_addresses.h */