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