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