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 /* ******************************** Scheduling API ***************************** */
 308
 309 /**
 310  * Handle to the ATS subsystem for bandwidth/transport scheduling information.
 311  */
 312 struct GNUNET_ATS_SchedulingHandle;
 313
 314 /**
 315  * Handle for address suggestion requests
 316  */
 317 struct GNUNET_ATS_SuggestHandle;
 318
 319 /**
 320  * Opaque session handle, defined by plugins.  Contents not known to ATS.
 321  */
 322 struct Session;
 323
 324 /**
 325  * Signature of a function called by ATS with the current bandwidth
 326  * and address preferences as determined by ATS.
 327  *
 328  * If an address is available immediately the address will be included. If no
 329  * address can be suggested, address, session, bandwidth and ATS information will
 330  * be NULL/0. ATS will suggest an address as soon as it can provide such an
 331  * address
 332  *
 333  * @param cls closure
 334  * @param address suggested address (including peer identity of the peer)
 335  * @param session session to use
 336  * @param bandwidth_out assigned outbound bandwidth for the connection
 337  * @param bandwidth_in assigned inbound bandwidth for the connection
 338  * @param ats performance data for the address (as far as known)
 339  * @param ats_count number of performance records in @a ats
 340  */
 341 typedef void
 342 (*GNUNET_ATS_AddressSuggestionCallback) (void *cls,
 343     const struct GNUNET_PeerIdentity *peer,
 344     const struct GNUNET_HELLO_Address *address,
 345     struct Session *session,
 346     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 347     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 348     const struct GNUNET_ATS_Information *ats, uint32_t ats_count);
 349
 350
 351 /**
 352  * Initialize the ATS subsystem.
 353  *
 354  * @param cfg configuration to use
 355  * @param suggest_cb notification to call whenever the suggestation changed
 356  * @param suggest_cb_cls closure for @a suggest_cb
 357  * @return ats context
 358  */
 359 struct GNUNET_ATS_SchedulingHandle *
 360 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 361     GNUNET_ATS_AddressSuggestionCallback suggest_cb, void *suggest_cb_cls);
 362
 363
 364 /**
 365  * Client is done with ATS scheduling, release resources.
 366  *
 367  * @param sh handle to release
 368  */
 369 void
 370 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh);
 371
 372
 373 /**
 374  * We would like to reset the address suggestion block time for this
 375  * peer.
 376  *
 377  * @param sh handle
 378  * @param peer identity of the peer we want to reset
 379  */
 380 void
 381 GNUNET_ATS_reset_backoff (struct GNUNET_ATS_SchedulingHandle *sh,
 382                           const struct GNUNET_PeerIdentity *peer);
 383
 384
 385 /**
 386  * We would like to establish a new connection with a peer.  ATS
 387  * should suggest a good address to begin with.
 388  *
 389  * @param sh handle
 390  * @param peer identity of the peer we need an address for
 391  * @return suggestion handle
 392  */
 393 struct GNUNET_ATS_SuggestHandle *
 394 GNUNET_ATS_suggest_address (struct GNUNET_ATS_SchedulingHandle *sh,
 395                             const struct GNUNET_PeerIdentity *peer);
 396
 397
 398 /**
 399  * We want to cancel ATS suggesting addresses for a peer.
 400  *
 401  * @param sh handle
 402  * @param peer identity of the peer
 403  */
 404 void
 405 GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SchedulingHandle *sh,
 406                                    const struct GNUNET_PeerIdentity *peer);
 407
 408
 409 /**
 410  * Convert a ATS property to a string
 411  *
 412  * @param type the property type
 413  * @return a string or NULL if invalid
 414  */
 415 const char *
 416 GNUNET_ATS_print_property_type (enum GNUNET_ATS_Property type);
 417
 418
 419 /**
 420  * Convert a `enum GNUNET_ATS_Network_Type` to a string
 421  *
 422  * @param net the network type
 423  * @return a string or NULL if invalid
 424  */
 425 const char *
 426 GNUNET_ATS_print_network_type (enum GNUNET_ATS_Network_Type net);
 427
 428
 429 /**
 430  * Returns where the address is located: LAN or WAN or ...
 431  *
 432  * @param sh the `struct GNUNET_ATS_SchedulingHandle` handle
 433  * @param addr address
 434  * @param addrlen address length
 435  * @return type of the network the address belongs to
 436  */
 437 enum GNUNET_ATS_Network_Type
 438 GNUNET_ATS_address_get_type (struct GNUNET_ATS_SchedulingHandle *sh,
 439                              const struct sockaddr *addr,
 440                              socklen_t addrlen);
 441
 442
 443 /**
 444  * Test if a address and a session is known to ATS.
 445  *
 446  * @param sh the scheduling handle
 447  * @param address the address
 448  * @param session the session
 449  * @return #GNUNET_YES or #GNUNET_NO
 450  */
 451 int
 452 GNUNET_ATS_session_known (struct GNUNET_ATS_SchedulingHandle *sh,
 453                           const struct GNUNET_HELLO_Address *address,
 454                           struct Session *session);
 455
 456
 457 /**
 458  * We have a new address ATS should know. Addresses have to be added with this
 459  * function before they can be: updated, set in use and destroyed
 460  *
 461  * @param sh handle
 462  * @param address the address
 463  * @param session session handle (if available)
 464  * @param ats performance data for the address
 465  * @param ats_count number of performance records in @a ats
 466  */
 467 int
 468 GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
 469                         const struct GNUNET_HELLO_Address *address,
 470                         struct Session *session,
 471                         const struct GNUNET_ATS_Information *ats,
 472                         uint32_t ats_count);
 473
 474
 475 /**
 476  * We have updated performance statistics for a given address.  Note
 477  * that this function can be called for addresses that are currently
 478  * in use as well as addresses that are valid but not actively in use.
 479  * Furthermore, the peer may not even be connected to us right now (in
 480  * which case the call may be ignored or the information may be stored
 481  * for later use).  Update bandwidth assignments.
 482  *
 483  * @param sh handle
 484  * @param address updated address
 485  * @param session session handle (if available)
 486  * @param ats performance data for the address
 487  * @param ats_count number of performance records in @a ats
 488  * @return #GNUNET_OK or #GNUNET_SYSERR
 489  */
 490 int
 491 GNUNET_ATS_address_update (struct GNUNET_ATS_SchedulingHandle *sh,
 492                            const struct GNUNET_HELLO_Address *address,
 493                            struct Session *session,
 494                            const struct GNUNET_ATS_Information *ats,
 495                            uint32_t ats_count);
 496
 497
 498 /**
 499  * An address is now in use or not used any more.
 500  *
 501  * @param sh handle
 502  * @param address the address
 503  * @param session session handle
 504  * @param in_use #GNUNET_YES if this address is now used, #GNUNET_NO
 505  * if address is not used any more
 506  */
 507 void
 508 GNUNET_ATS_address_in_use (struct GNUNET_ATS_SchedulingHandle *sh,
 509                            const struct GNUNET_HELLO_Address *address,
 510                            struct Session *session,
 511                            int in_use);
 512
 513
 514 /**
 515  * An address got destroyed, stop including it as a valid address.
 516  *
 517  * If a session is given, only the session will be removed, if no session is
 518  * given the full address will be deleted.
 519  *
 520  * @param sh handle
 521  * @param address the address
 522  * @param session session handle that is no longer valid (if available)
 523  */
 524 void
 525 GNUNET_ATS_address_destroyed (struct GNUNET_ATS_SchedulingHandle *sh,
 526                               const struct GNUNET_HELLO_Address *address,
 527                               struct Session *session);
 528
 529
 530 /* ******************************** Performance API ***************************** */
 531
 532 /**
 533  * ATS Handle to obtain and/or modify performance information.
 534  */
 535 struct GNUNET_ATS_PerformanceHandle;
 536
 537 /**
 538  * Signature of a function that is called with QoS information about an address.
 539  *
 540  * @param cls closure
 541  * @param address the address, NULL if ATS service was disconnected
 542  * @param address_active #GNUNET_YES if this address is actively used
 543  *        to maintain a connection to a peer;
 544  *        #GNUNET_NO if the address is not actively used;
 545  *        #GNUNET_SYSERR if this address is no longer available for ATS
 546  * @param bandwidth_out assigned outbound bandwidth for the connection
 547  * @param bandwidth_in assigned inbound bandwidth for the connection
 548  * @param ats performance data for the address (as far as known)
 549  * @param ats_count number of performance records in @a ats
 550  */
 551 typedef void
 552 (*GNUNET_ATS_AddressInformationCallback) (void *cls,
 553                                           const struct GNUNET_HELLO_Address *address,
 554                                           int address_active,
 555                                           struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 556                                           struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 557                                           const struct GNUNET_ATS_Information *ats,
 558                                           uint32_t ats_count);
 559
 560
 561 /**
 562  * Handle for an address listing operation
 563  */
 564 struct GNUNET_ATS_AddressListHandle;
 565
 566
 567 /**
 568  * Get handle to access performance API of the ATS subsystem.
 569  *
 570  * @param cfg configuration to use
 571  * @param addr_info_cb callback called when performance characteristics for
 572  *      an address change
 573  * @param addr_info_cb_cls closure for @a addr_info_cb
 574  * @return ats performance context
 575  */
 576 struct GNUNET_ATS_PerformanceHandle *
 577 GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 578                              GNUNET_ATS_AddressInformationCallback addr_info_cb,
 579                              void *addr_info_cb_cls);
 580
 581
 582
 583 /**
 584  * Get information about addresses known to the ATS subsystem.
 585  *
 586  * @param handle the performance handle to use
 587  * @param peer peer idm can be NULL for all peers
 588  * @param all GNUNET_YES to get information about all addresses or GNUNET_NO to
 589  *        get only address currently used
 590  * @param infocb callback to call with the addresses,
 591  *        will callback with address == NULL when done
 592  * @param infocb_cls closure for @a infocb
 593  * @return ats performance context
 594  */
 595 struct GNUNET_ATS_AddressListHandle *
 596 GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *handle,
 597                                        const struct GNUNET_PeerIdentity *peer,
 598                                        int all,
 599                                        GNUNET_ATS_AddressInformationCallback infocb,
 600                                        void *infocb_cls);
 601
 602
 603 /**
 604  * Cancel a pending address listing operation
 605  *
 606  * @param handle the `struct GNUNET_ATS_AddressListHandle` handle to cancel
 607  */
 608 void
 609 GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandle *handle);
 610
 611
 612 /**
 613  * Client is done using the ATS performance subsystem, release resources.
 614  *
 615  * @param ph handle
 616  */
 617 void
 618 GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph);
 619
 620
 621 /**
 622  * Function called with reservation result.
 623  *
 624  * @param cls closure
 625  * @param peer identifies the peer
 626  * @param amount set to the amount that was actually reserved or unreserved;
 627  *               either the full requested amount or zero (no partial reservations)
 628  * @param res_delay if the reservation could not be satisfied (amount was 0), how
 629  *        long should the client wait until re-trying?
 630  */
 631 typedef void
 632 (*GNUNET_ATS_ReservationCallback) (void *cls,
 633                                    const struct GNUNET_PeerIdentity * peer,
 634                                    int32_t amount,
 635                                    struct GNUNET_TIME_Relative res_delay);
 636
 637
 638 /**
 639  * Context that can be used to cancel a peer information request.
 640  */
 641 struct GNUNET_ATS_ReservationContext;
 642
 643
 644 /**
 645  * Reserve inbound bandwidth from the given peer.  ATS will look at
 646  * the current amount of traffic we receive from the peer and ensure
 647  * that the peer could add 'amount' of data to its stream.
 648  *
 649  * @param ph performance handle
 650  * @param peer identifies the peer
 651  * @param amount reserve N bytes for receiving, negative
 652  *                amounts can be used to undo a (recent) reservation;
 653  * @param rcb function to call with the resulting reservation information
 654  * @param rcb_cls closure for info
 655  * @return NULL on error
 656  * @deprecated will be replaced soon
 657  */
 658 struct GNUNET_ATS_ReservationContext *
 659 GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
 660     const struct GNUNET_PeerIdentity *peer, int32_t amount,
 661     GNUNET_ATS_ReservationCallback rcb, void *rcb_cls);
 662
 663
 664 /**
 665  * Cancel request for reserving bandwidth.
 666  *
 667  * @param rc context returned by the original GNUNET_ATS_reserve_bandwidth call
 668  */
 669 void
 670 GNUNET_ATS_reserve_bandwidth_cancel (struct GNUNET_ATS_ReservationContext *rc);
 671
 672 /**
 673  * Number of preference types supported by ATS
 674  */
 675 #define GNUNET_ATS_PreferenceCount 3
 676
 677 /**
 678  * ATS preference types as array initializer
 679  */
 680 #define GNUNET_ATS_PreferenceType {GNUNET_ATS_PREFERENCE_END, GNUNET_ATS_PREFERENCE_BANDWIDTH, GNUNET_ATS_PREFERENCE_LATENCY}
 681
 682 /**
 683  * ATS preference types as string array initializer
 684  */
 685 #define GNUNET_ATS_PreferenceTypeString {"END", "BANDWIDTH", "LATENCY"}
 686
 687 /**
 688  * Enum defining all known preference categories.
 689  */
 690 enum GNUNET_ATS_PreferenceKind
 691 {
 692
 693   /**
 694    * End of preference list.
 695    */
 696   GNUNET_ATS_PREFERENCE_END = 0,
 697
 698   /**
 699    * Change the peer's bandwidth value (value per byte of bandwidth in
 700    * the goal function) to the given amount.  The argument is followed
 701    * by a double value giving the desired value (can be negative).
 702    * Preference changes are forgotten if peers disconnect.
 703    */
 704   GNUNET_ATS_PREFERENCE_BANDWIDTH,
 705
 706   /**
 707    * Change the peer's latency value to the given amount.  The
 708    * argument is followed by a double value giving the desired value
 709    * (can be negative).  The absolute score in the goal function is
 710    * the inverse of the latency in microseconds (minimum: 1
 711    * microsecond) multiplied by the latency preferences.
 712    */
 713   GNUNET_ATS_PREFERENCE_LATENCY
 714 };
 715
 716 /**
 717  * Convert a GNUNET_ATS_PreferenceType to a string
 718  *
 719  * @param type the preference type
 720  * @return a string or NULL if invalid
 721  */
 722 const char *
 723 GNUNET_ATS_print_preference_type (uint32_t type);
 724
 725
 726 /**
 727  * Change preferences for the given peer. Preference changes are forgotten if peers
 728  * disconnect.
 729  *
 730  * @param ph performance handle
 731  * @param peer identifies the peer
 732  * @param ... 0-terminated specification of the desired changes
 733  */
 734 void
 735 GNUNET_ATS_performance_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
 736                                           const struct GNUNET_PeerIdentity *peer, ...);
 737
 738
 739 /**
 740  * Application feedback on how good preference requirements are fulfilled
 741  * for the preferences included in the given time scope [now - scope .. now]
 742  *
 743  * An application notifies ATS if (and only if) it has feedback information
 744  * for specific properties. This values are valid until the feedback scores are
 745  * updated by the application.
 746  *
 747  * If the application has no feedback for this preference kind the application
 748  * will not explicitly call for this property and will not include it in this
 749  * function call.
 750  *
 751  * @param ph performance handle
 752  * @param scope the time interval this valid for: [now - scope .. now]
 753  * @param peer identifies the peer
 754  * @param ... 0-terminated specification of the desired changes
 755  */
 756 void
 757 GNUNET_ATS_performance_give_feedback (struct GNUNET_ATS_PerformanceHandle *ph,
 758     const struct GNUNET_PeerIdentity *peer,
 759     const struct GNUNET_TIME_Relative scope, ...);
 760
 761 #endif
 762 /* end of file gnunet-service-transport_ats.h */