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