src/include/gnunet_ats_service.h

   1 /*
   2  This file is part of GNUnet.
   3  (C) 2010-2015 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  * @file include/gnunet_ats_service.h
  22  * @brief automatic transport selection and outbound bandwidth determination
  23  * @author Christian Grothoff
  24  * @author Matthias Wachs
  25  */
  26 #ifndef GNUNET_ATS_SERVICE_H
  27 #define GNUNET_ATS_SERVICE_H
  28
  29 #include "gnunet_constants.h"
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_hello_lib.h"
  32
  33 /**
  34  * Number of network types supported by ATS
  35  */
  36 #define GNUNET_ATS_NetworkTypeCount 6
  37
  38
  39 /**
  40  * Types of networks (with separate quotas) we support.
  41  */
  42 enum GNUNET_ATS_Network_Type
  43 {
  44   /**
  45    * Category of last resort.
  46    */
  47   GNUNET_ATS_NET_UNSPECIFIED = 0,
  48
  49   /**
  50    * Loopback (same host).
  51    */
  52   GNUNET_ATS_NET_LOOPBACK = 1,
  53
  54   /**
  55    * Local area network.
  56    */
  57   GNUNET_ATS_NET_LAN = 2,
  58
  59   /**
  60    * Wide area network (i.e. Internet)
  61    */
  62   GNUNET_ATS_NET_WAN = 3,
  63
  64   /**
  65    * Wireless LAN (i.e. 802.11abgn)
  66    */
  67   GNUNET_ATS_NET_WLAN = 4,
  68
  69   /**
  70    * Bluetooth LAN
  71    */
  72   GNUNET_ATS_NET_BT = 5
  73 };
  74
  75
  76 /**
  77  * ATS network types as array initializer
  78  */
  79 #define GNUNET_ATS_NetworkType { GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN, GNUNET_ATS_NET_BT }
  80
  81
  82
  83 /**
  84  * Default bandwidth assigned to a network : 64 KB/s
  85  */
  86 #define GNUNET_ATS_DefaultBandwidth 65536
  87
  88 /**
  89  * Undefined value for an `enum GNUNET_ATS_Property`
  90  */
  91 #define GNUNET_ATS_VALUE_UNDEFINED UINT32_MAX
  92
  93 /**
  94  * String representation for GNUNET_ATS_VALUE_UNDEFINED
  95  */
  96 #define GNUNET_ATS_VALUE_UNDEFINED_STR "undefined"
  97
  98 /**
  99  * Maximum bandwidth assigned to a network : 4095 MB/s
 100  */
 101 #define GNUNET_ATS_MaxBandwidth UINT32_MAX
 102
 103 /**
 104  * Textual equivalent for GNUNET_ATS_MaxBandwidth
 105  */
 106 #define GNUNET_ATS_MaxBandwidthString "unlimited"
 107
 108 /**
 109  * Number of property types supported by ATS
 110  */
 111 #define GNUNET_ATS_PropertyCount 11
 112
 113
 114 /**
 115  * Enum defining all known property types for ATS Enum values are used
 116  * in the GNUNET_ATS_Information struct as
 117  * (key,value)-pairs.
 118  *
 119  * Cost are always stored in uint32_t, so all units used to define costs
 120  * have to be normalized to fit in uint32_t [0 .. UINT32_MAX-1]
 121  *
 122  * UINT32_MAX is reserved for uninitialized values #GNUNET_ATS_VALUE_UNDEFINED
 123  */
 124 enum GNUNET_ATS_Property
 125 {
 126
 127   /**
 128    * End of the array.
 129    * @deprecated
 130    */
 131   GNUNET_ATS_ARRAY_TERMINATOR = 0,
 132
 133   /**
 134    * Actual traffic on this connection from this peer to the other peer.
 135    * Includes transport overhead
 136    *
 137    * Unit: [bytes/second]
 138    */
 139   GNUNET_ATS_UTILIZATION_OUT,
 140
 141   /**
 142    * Actual traffic on this connection from the other peer to this peer.
 143    * Includes transport overhead
 144    *
 145    * Unit: [bytes/second]
 146    */
 147   GNUNET_ATS_UTILIZATION_IN,
 148
 149   /**
 150    * Actual traffic on this connection from this peer to the other peer.
 151    * Only payload from layers > transport
 152    *
 153    * Unit: [bytes/second]
 154    */
 155   GNUNET_ATS_UTILIZATION_PAYLOAD_OUT,
 156
 157   /**
 158    * Actual traffic on this connection from the other peer to this peer.
 159    * Only payload from layers > transport
 160    *
 161    * Unit: [bytes/second]
 162    */
 163   GNUNET_ATS_UTILIZATION_PAYLOAD_IN,
 164
 165   /**
 166    * Is this address located in WAN, LAN or a loopback address
 167    * Value is element of GNUNET_ATS_Network_Type
 168    */
 169   GNUNET_ATS_NETWORK_TYPE,
 170
 171   /**
 172    * Delay
 173    * Time between when the time packet is sent and the packet arrives
 174    *
 175    * Unit: [microseconds]
 176    *
 177    * Examples:
 178    *
 179    * LAN   :    1
 180    * WLAN  :    2
 181    * Dialup:  500
 182    */
 183   GNUNET_ATS_QUALITY_NET_DELAY,
 184
 185   /**
 186    * Distance on network layer (required for distance-vector routing).
 187    *
 188    * Unit: [DV-hops]
 189    */
 190   GNUNET_ATS_QUALITY_NET_DISTANCE,
 191
 192   /**
 193    * Network overhead on WAN (Wide-Area Network)
 194    *
 195    * How many bytes are sent on the WAN when 1 kilobyte (1024 bytes)
 196    * of application data is transmitted?
 197    * A factor used with connect cost, bandwidth cost and energy cost
 198    * to describe the overhead produced by the transport protocol
 199    *
 200    * Unit: [bytes/kb]
 201    *
 202    * Interpretation: less is better
 203    *
 204    * Examples:
 205    *
 206    * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
 207    * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
 208    * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8  = 1090 [bytes/kb]
 209    * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8  = 1110 [bytes/kb]
 210    */
 211   GNUNET_ATS_COST_WAN,
 212
 213   /**
 214    * Network overhead on LAN (Local-Area Network)
 215    *
 216    * How many bytes are sent on the LAN when 1 kilobyte (1024 bytes)
 217    * of application data is transmitted?
 218    * A factor used with connect cost, bandwidth cost and energy cost
 219    * to describe the overhead produced by the transport protocol
 220    *
 221    * Unit: [bytes/kb]
 222    *
 223    * Interpretation: less is better
 224    *
 225    * Examples:
 226    *
 227    * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
 228    * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
 229    * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8  = 1090 [bytes/kb]
 230    * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8  = 1110 [bytes/kb]
 231    */
 232   GNUNET_ATS_COST_LAN,
 233
 234   /**
 235    * Network overhead on WLAN (Wireless Local Area Network)
 236    *
 237    * How many bytes are sent on the LAN when 1 kilobyte (1024 bytes)
 238    * of application data is transmitted?
 239    * A factor used with connect cost, bandwidth cost and energy cost
 240    * to describe the overhead produced by the transport protocol
 241    *
 242    * Unit: [bytes/kb]
 243    *
 244    * Interpretation: less is better
 245    *
 246    * Examples:
 247    *
 248    * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
 249    * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
 250    * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8  = 1090 [bytes/kb]
 251    * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8  = 1110 [bytes/kb]
 252    */
 253   GNUNET_ATS_COST_WLAN
 254
 255 };
 256
 257
 258 /**
 259  * Number of ATS quality properties
 260  */
 261 #define GNUNET_ATS_QualityPropertiesCount 2
 262
 263 /**
 264  * ATS quality properties as array initializer
 265  */
 266 #define GNUNET_ATS_QualityProperties { GNUNET_ATS_QUALITY_NET_DELAY, GNUNET_ATS_QUALITY_NET_DISTANCE }
 267
 268 /**
 269  * ATS quality properties as string array initializer
 270  */
 271 #define GNUNET_ATS_QualityPropertiesString {"Delay", "Distance"}
 272
 273 GNUNET_NETWORK_STRUCT_BEGIN
 274
 275 /**
 276  * struct used to communicate the transport's properties like cost and
 277  * quality of service as well as high-level constraints on resource
 278  * consumption.
 279  *
 280  *                             +---+
 281  *  +-----------+ Constraints  |   |  Plugin properties +---------+
 282  *  | Highlevel |------------> |ATS| <------------------|Transport|
 283  *  | Component | ATS struct   |   |    ATS struct      | Plugin  |
 284  *  +-----------+              |   |                    +---------+
 285  *                             +---+
 286  *
 287  * This structure will be used by transport plugins to communicate
 288  * costs to ATS or by higher level components to tell ATS their
 289  * constraints.  Always a pair of (GNUNET_ATS_Property,
 290  * uint32_t value).  Value is always uint32_t, so all units used to
 291  * define costs have to be normalized to fit uint32_t.
 292  */
 293 struct GNUNET_ATS_Information
 294 {
 295   /**
 296    * ATS property type, in network byte order.
 297    */
 298   uint32_t type GNUNET_PACKED;
 299
 300   /**
 301    * ATS property value, in network byte order.
 302    */
 303   uint32_t value GNUNET_PACKED;
 304 };
 305 GNUNET_NETWORK_STRUCT_END
 306
 307
 308 /* ********************Connection Suggestion API ***************************** */
 309
 310 /**
 311  * Handle to the ATS subsystem for making suggestions about
 312  * connections the peer would like to have.
 313  */
 314 struct GNUNET_ATS_ConnectivityHandle;
 315
 316 /**
 317  * Handle for address suggestion requests.
 318  */
 319 struct GNUNET_ATS_ConnectivitySuggestHandle;
 320
 321
 322 /**
 323  * Initialize the ATS connectivity suggestion client handle.
 324  *
 325  * @param cfg configuration to use
 326  * @return ats connectivity handle, NULL on error
 327  */
 328 struct GNUNET_ATS_ConnectivityHandle *
 329 GNUNET_ATS_connectivity_init (const struct GNUNET_CONFIGURATION_Handle *cfg);
 330
 331
 332 /**
 333  * Shutdown ATS connectivity suggestion client.
 334  *
 335  * @param ch handle to destroy
 336  */
 337 void
 338 GNUNET_ATS_connectivity_done (struct GNUNET_ATS_ConnectivityHandle *ch);
 339
 340
 341 /**
 342  * We would like to establish a new connection with a peer.  ATS
 343  * should suggest a good address to begin with.
 344  *
 345  * @param ch handle
 346  * @param peer identity of the peer we need an address for
 347  * @return suggestion handle, NULL if request is already pending
 348  */
 349 struct GNUNET_ATS_ConnectivitySuggestHandle *
 350 GNUNET_ATS_connectivity_suggest (struct GNUNET_ATS_ConnectivityHandle *ch,
 351                                  const struct GNUNET_PeerIdentity *peer);
 352
 353
 354 /**
 355  * We no longer care about being connected to a peer.
 356  *
 357  * @param sh handle
 358  */
 359 void
 360 GNUNET_ATS_connectivity_suggest_cancel (struct GNUNET_ATS_ConnectivitySuggestHandle *sh);
 361
 362
 363 /* ******************************** Scheduling API ***************************** */
 364
 365 /**
 366  * Handle to the ATS subsystem for bandwidth/transport scheduling information.
 367  */
 368 struct GNUNET_ATS_SchedulingHandle;
 369
 370 /**
 371  * Opaque session handle, defined by plugins.  Contents not known to ATS.
 372  */
 373 struct Session;
 374
 375 /**
 376  * Signature of a function called by ATS with the current bandwidth
 377  * and address preferences as determined by ATS.
 378  *
 379  * @param cls closure
 380  * @param address suggested address (including peer identity of the peer)
 381  * @param session session to use, NULL to establish a new outgoing session
 382  * @param bandwidth_out assigned outbound bandwidth for the connection,
 383  *        0 to disconnect
 384  * @param bandwidth_in assigned inbound bandwidth for the connection,
 385  *        0 to disconnect
 386  */
 387 typedef void
 388 (*GNUNET_ATS_AddressSuggestionCallback) (void *cls,
 389     const struct GNUNET_PeerIdentity *peer,
 390     const struct GNUNET_HELLO_Address *address,
 391     struct Session *session,
 392     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 393     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
 394
 395
 396 /**
 397  * Initialize the ATS scheduling subsystem.
 398  *
 399  * @param cfg configuration to use
 400  * @param suggest_cb notification to call whenever the suggestation changed
 401  * @param suggest_cb_cls closure for @a suggest_cb
 402  * @return ats context
 403  */
 404 struct GNUNET_ATS_SchedulingHandle *
 405 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 406     GNUNET_ATS_AddressSuggestionCallback suggest_cb, void *suggest_cb_cls);
 407
 408
 409 /**
 410  * Client is done with ATS scheduling, release resources.
 411  *
 412  * @param sh handle to release
 413  */
 414 void
 415 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh);
 416
 417
 418 /**
 419  * We would like to reset the address suggestion block time for this
 420  * peer.
 421  *
 422  * @param sh handle
 423  * @param peer identity of the peer we want to reset
 424  */
 425 void
 426 GNUNET_ATS_reset_backoff (struct GNUNET_ATS_SchedulingHandle *sh,
 427                           const struct GNUNET_PeerIdentity *peer);
 428
 429
 430 /**
 431  * Convert a ATS property to a string
 432  *
 433  * @param type the property type
 434  * @return a string or NULL if invalid
 435  */
 436 const char *
 437 GNUNET_ATS_print_property_type (enum GNUNET_ATS_Property type);
 438
 439
 440 /**
 441  * Convert a `enum GNUNET_ATS_Network_Type` to a string
 442  *
 443  * @param net the network type
 444  * @return a string or NULL if invalid
 445  */
 446 const char *
 447 GNUNET_ATS_print_network_type (enum GNUNET_ATS_Network_Type net);
 448
 449
 450 /**
 451  * Returns where the address is located: loopback, LAN or WAN.
 452  *
 453  * @param sh the `struct GNUNET_ATS_SchedulingHandle` handle
 454  * @param addr address
 455  * @param addrlen address length
 456  * @return type of the network the address belongs to
 457  */
 458 enum GNUNET_ATS_Network_Type
 459 GNUNET_ATS_address_get_type (struct GNUNET_ATS_SchedulingHandle *sh,
 460                              const struct sockaddr *addr,
 461                              socklen_t addrlen);
 462
 463
 464 /**
 465  * Test if a address and a session is known to ATS.
 466  *
 467  * @param sh the scheduling handle
 468  * @param address the address
 469  * @param session the session
 470  * @return #GNUNET_YES or #GNUNET_NO
 471  */
 472 int
 473 GNUNET_ATS_session_known (struct GNUNET_ATS_SchedulingHandle *sh,
 474                           const struct GNUNET_HELLO_Address *address,
 475                           struct Session *session);
 476
 477
 478 /**
 479  * Handle used within ATS to track an address.
 480  */
 481 struct GNUNET_ATS_AddressRecord;
 482
 483
 484 /**
 485  * We have a new address ATS should know. Addresses have to be added with this
 486  * function before they can be: updated, set in use and destroyed
 487  *
 488  * @param sh handle
 489  * @param address the address
 490  * @param session session handle (if available, i.e. for incoming connections)
 491  * @param ats performance data for the address
 492  * @param ats_count number of performance records in @a ats
 493  * @return handle to the address representation inside ATS, NULL
 494  *         on error (i.e. ATS knows this exact address already, or
 495  *         address is invalid)
 496  */
 497 struct GNUNET_ATS_AddressRecord *
 498 GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
 499                         const struct GNUNET_HELLO_Address *address,
 500                         struct Session *session,
 501                         const struct GNUNET_ATS_Information *ats,
 502                         uint32_t ats_count);
 503
 504
 505 /**
 506  * An address was used to initiate a session.
 507  *
 508  * @param ar address record to update information for
 509  * @param session session handle
 510  */
 511 void
 512 GNUNET_ATS_address_add_session (struct GNUNET_ATS_AddressRecord *ar,
 513                                 struct Session *session);
 514
 515
 516 /**
 517  * A session was destroyed, disassociate it from the
 518  * given address record.  If this was an incoming
 519  * addess, destroy the address as well.
 520  *
 521  * @param ar address record to update information for
 522  * @param session session handle
 523  * @return #GNUNET_YES if the @a ar was destroyed because
 524  *                     it was an incoming address,
 525  *         #GNUNET_NO if the @ar was kept because we can
 526  *                    use it still to establish a new session
 527  */
 528 int
 529 GNUNET_ATS_address_del_session (struct GNUNET_ATS_AddressRecord *ar,
 530                                 struct Session *session);
 531
 532
 533 /**
 534  * We have updated performance statistics for a given address.  Note
 535  * that this function can be called for addresses that are currently
 536  * in use as well as addresses that are valid but not actively in use.
 537  * Furthermore, the peer may not even be connected to us right now (@a
 538  * session value of NULL used to signal disconnect, or somehow we
 539  * otherwise got updated on @a ats information).  Based on the
 540  * information provided, ATS may update bandwidth assignments and
 541  * suggest to switch addresses.
 542  *
 543  * @param ar address record to update information for
 544  * @param ats performance data for the address
 545  * @param ats_count number of performance records in @a ats
 546  */
 547 void
 548 GNUNET_ATS_address_update (struct GNUNET_ATS_AddressRecord *ar,
 549                            const struct GNUNET_ATS_Information *ats,
 550                            uint32_t ats_count);
 551
 552
 553 /**
 554  * An address is now in use, or not used any more.
 555  *
 556  * @param ar address record for which to toggle the flag
 557  * @param in_use #GNUNET_YES if this address is now used, #GNUNET_NO
 558  *               if address is not used any more
 559  */
 560 void
 561 GNUNET_ATS_address_set_in_use (struct GNUNET_ATS_AddressRecord *ar,
 562                                int in_use);
 563
 564
 565 /**
 566  * An address got destroyed, stop using it as a valid address.
 567  *
 568  * @param ar address record to destroy, it's validation has
 569  *           expired and ATS may no longer use it
 570  */
 571 void
 572 GNUNET_ATS_address_destroy (struct GNUNET_ATS_AddressRecord *ar);
 573
 574
 575
 576 /* ******************************** Performance API ***************************** */
 577
 578 /**
 579  * ATS Handle to obtain and/or modify performance information.
 580  */
 581 struct GNUNET_ATS_PerformanceHandle;
 582
 583 /**
 584  * Signature of a function that is called with QoS information about an address.
 585  *
 586  * @param cls closure
 587  * @param address the address, NULL if ATS service was disconnected
 588  * @param address_active #GNUNET_YES if this address is actively used
 589  *        to maintain a connection to a peer;
 590  *        #GNUNET_NO if the address is not actively used;
 591  *        #GNUNET_SYSERR if this address is no longer available for ATS
 592  * @param bandwidth_out assigned outbound bandwidth for the connection
 593  * @param bandwidth_in assigned inbound bandwidth for the connection
 594  * @param ats performance data for the address (as far as known)
 595  * @param ats_count number of performance records in @a ats
 596  */
 597 typedef void
 598 (*GNUNET_ATS_AddressInformationCallback) (void *cls,
 599                                           const struct GNUNET_HELLO_Address *address,
 600                                           int address_active,
 601                                           struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 602                                           struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 603                                           const struct GNUNET_ATS_Information *ats,
 604                                           uint32_t ats_count);
 605
 606
 607 /**
 608  * Handle for an address listing operation
 609  */
 610 struct GNUNET_ATS_AddressListHandle;
 611
 612
 613 /**
 614  * Get handle to access performance API of the ATS subsystem.
 615  *
 616  * @param cfg configuration to use
 617  * @param addr_info_cb callback called when performance characteristics for
 618  *      an address change
 619  * @param addr_info_cb_cls closure for @a addr_info_cb
 620  * @return ats performance context
 621  */
 622 struct GNUNET_ATS_PerformanceHandle *
 623 GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 624                              GNUNET_ATS_AddressInformationCallback addr_info_cb,
 625                              void *addr_info_cb_cls);
 626
 627
 628
 629 /**
 630  * Get information about addresses known to the ATS subsystem.
 631  *
 632  * @param handle the performance handle to use
 633  * @param peer peer idm can be NULL for all peers
 634  * @param all GNUNET_YES to get information about all addresses or GNUNET_NO to
 635  *        get only address currently used
 636  * @param infocb callback to call with the addresses,
 637  *        will callback with address == NULL when done
 638  * @param infocb_cls closure for @a infocb
 639  * @return ats performance context
 640  */
 641 struct GNUNET_ATS_AddressListHandle *
 642 GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *handle,
 643                                        const struct GNUNET_PeerIdentity *peer,
 644                                        int all,
 645                                        GNUNET_ATS_AddressInformationCallback infocb,
 646                                        void *infocb_cls);
 647
 648
 649 /**
 650  * Cancel a pending address listing operation
 651  *
 652  * @param handle the `struct GNUNET_ATS_AddressListHandle` handle to cancel
 653  */
 654 void
 655 GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandle *handle);
 656
 657
 658 /**
 659  * Client is done using the ATS performance subsystem, release resources.
 660  *
 661  * @param ph handle
 662  */
 663 void
 664 GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph);
 665
 666
 667 /**
 668  * Function called with reservation result.
 669  *
 670  * @param cls closure
 671  * @param peer identifies the peer
 672  * @param amount set to the amount that was actually reserved or unreserved;
 673  *               either the full requested amount or zero (no partial reservations)
 674  * @param res_delay if the reservation could not be satisfied (amount was 0), how
 675  *        long should the client wait until re-trying?
 676  */
 677 typedef void
 678 (*GNUNET_ATS_ReservationCallback) (void *cls,
 679                                    const struct GNUNET_PeerIdentity * peer,
 680                                    int32_t amount,
 681                                    struct GNUNET_TIME_Relative res_delay);
 682
 683
 684 /**
 685  * Context that can be used to cancel a peer information request.
 686  */
 687 struct GNUNET_ATS_ReservationContext;
 688
 689
 690 /**
 691  * Reserve inbound bandwidth from the given peer.  ATS will look at
 692  * the current amount of traffic we receive from the peer and ensure
 693  * that the peer could add 'amount' of data to its stream.
 694  *
 695  * @param ph performance handle
 696  * @param peer identifies the peer
 697  * @param amount reserve N bytes for receiving, negative
 698  *                amounts can be used to undo a (recent) reservation;
 699  * @param rcb function to call with the resulting reservation information
 700  * @param rcb_cls closure for info
 701  * @return NULL on error
 702  * @deprecated will be replaced soon
 703  */
 704 struct GNUNET_ATS_ReservationContext *
 705 GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
 706     const struct GNUNET_PeerIdentity *peer, int32_t amount,
 707     GNUNET_ATS_ReservationCallback rcb, void *rcb_cls);
 708
 709
 710 /**
 711  * Cancel request for reserving bandwidth.
 712  *
 713  * @param rc context returned by the original GNUNET_ATS_reserve_bandwidth call
 714  */
 715 void
 716 GNUNET_ATS_reserve_bandwidth_cancel (struct GNUNET_ATS_ReservationContext *rc);
 717
 718 /**
 719  * Number of preference types supported by ATS
 720  */
 721 #define GNUNET_ATS_PreferenceCount 3
 722
 723 /**
 724  * ATS preference types as array initializer
 725  */
 726 #define GNUNET_ATS_PreferenceType {GNUNET_ATS_PREFERENCE_END, GNUNET_ATS_PREFERENCE_BANDWIDTH, GNUNET_ATS_PREFERENCE_LATENCY}
 727
 728 /**
 729  * ATS preference types as string array initializer
 730  */
 731 #define GNUNET_ATS_PreferenceTypeString {"END", "BANDWIDTH", "LATENCY"}
 732
 733 /**
 734  * Enum defining all known preference categories.
 735  */
 736 enum GNUNET_ATS_PreferenceKind
 737 {
 738
 739   /**
 740    * End of preference list.
 741    */
 742   GNUNET_ATS_PREFERENCE_END = 0,
 743
 744   /**
 745    * Change the peer's bandwidth value (value per byte of bandwidth in
 746    * the goal function) to the given amount.  The argument is followed
 747    * by a double value giving the desired value (can be negative).
 748    * Preference changes are forgotten if peers disconnect.
 749    */
 750   GNUNET_ATS_PREFERENCE_BANDWIDTH,
 751
 752   /**
 753    * Change the peer's latency value to the given amount.  The
 754    * argument is followed by a double value giving the desired value
 755    * (can be negative).  The absolute score in the goal function is
 756    * the inverse of the latency in microseconds (minimum: 1
 757    * microsecond) multiplied by the latency preferences.
 758    */
 759   GNUNET_ATS_PREFERENCE_LATENCY
 760 };
 761
 762 /**
 763  * Convert a GNUNET_ATS_PreferenceType to a string
 764  *
 765  * @param type the preference type
 766  * @return a string or NULL if invalid
 767  */
 768 const char *
 769 GNUNET_ATS_print_preference_type (uint32_t type);
 770
 771
 772 /**
 773  * Change preferences for the given peer. Preference changes are forgotten if peers
 774  * disconnect.
 775  *
 776  * @param ph performance handle
 777  * @param peer identifies the peer
 778  * @param ... 0-terminated specification of the desired changes
 779  */
 780 void
 781 GNUNET_ATS_performance_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
 782                                           const struct GNUNET_PeerIdentity *peer, ...);
 783
 784
 785 /**
 786  * Application feedback on how good preference requirements are fulfilled
 787  * for the preferences included in the given time scope [now - scope .. now]
 788  *
 789  * An application notifies ATS if (and only if) it has feedback information
 790  * for specific properties. This values are valid until the feedback scores are
 791  * updated by the application.
 792  *
 793  * If the application has no feedback for this preference kind the application
 794  * will not explicitly call for this property and will not include it in this
 795  * function call.
 796  *
 797  * @param ph performance handle
 798  * @param scope the time interval this valid for: [now - scope .. now]
 799  * @param peer identifies the peer
 800  * @param ... 0-terminated specification of the desired changes
 801  */
 802 void
 803 GNUNET_ATS_performance_give_feedback (struct GNUNET_ATS_PerformanceHandle *ph,
 804     const struct GNUNET_PeerIdentity *peer,
 805     const struct GNUNET_TIME_Relative scope, ...);
 806
 807 #endif
 808 /* end of file gnunet-service-transport_ats.h */