src/include/gnunet_ats_service.h

   1 /*
   2  This file is part of GNUnet.
   3  Copyright (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., 51 Franklin Street, Fifth Floor,
  18  Boston, MA 02110-1301, 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  * Types of networks (with separate quotas) we support.
  35  */
  36 enum GNUNET_ATS_Network_Type
  37 {
  38   /**
  39    * Category of last resort.
  40    */
  41   GNUNET_ATS_NET_UNSPECIFIED = 0,
  42
  43   /**
  44    * Loopback (same host).
  45    */
  46   GNUNET_ATS_NET_LOOPBACK = 1,
  47
  48   /**
  49    * Local area network.
  50    */
  51   GNUNET_ATS_NET_LAN = 2,
  52
  53   /**
  54    * Wide area network (i.e. Internet)
  55    */
  56   GNUNET_ATS_NET_WAN = 3,
  57
  58   /**
  59    * Wireless LAN (i.e. 802.11abgn)
  60    */
  61   GNUNET_ATS_NET_WLAN = 4,
  62
  63   /**
  64    * Bluetooth LAN
  65    */
  66   GNUNET_ATS_NET_BT = 5
  67
  68 /**
  69  * Number of network types supported by ATS
  70  */
  71 #define GNUNET_ATS_NetworkTypeCount 6
  72
  73 };
  74
  75
  76 /**
  77  * Default bandwidth assigned to a network : 64 KB/s
  78  */
  79 #define GNUNET_ATS_DefaultBandwidth 65536
  80
  81 /**
  82  * Undefined value for an `enum GNUNET_ATS_Property`
  83  */
  84 #define GNUNET_ATS_VALUE_UNDEFINED UINT32_MAX
  85
  86 /**
  87  * String representation for GNUNET_ATS_VALUE_UNDEFINED
  88  */
  89 #define GNUNET_ATS_VALUE_UNDEFINED_STR "undefined"
  90
  91 /**
  92  * Maximum bandwidth assigned to a network : 4095 MB/s
  93  */
  94 #define GNUNET_ATS_MaxBandwidth UINT32_MAX
  95
  96 /**
  97  * Textual equivalent for GNUNET_ATS_MaxBandwidth
  98  */
  99 #define GNUNET_ATS_MaxBandwidthString "unlimited"
 100
 101
 102 /**
 103  * ATS performance characteristics for an address.
 104  */
 105 struct GNUNET_ATS_Properties
 106 {
 107
 108   /**
 109    * Delay.  Time between when the time packet is sent and the packet
 110    * arrives.  FOREVER if we did not measure yet.
 111    */
 112   struct GNUNET_TIME_Relative delay;
 113
 114   /**
 115    * Actual traffic on this connection from this peer to the other peer.
 116    * Includes transport overhead.
 117    *
 118    * Unit: [bytes/second]
 119    */
 120   uint32_t utilization_out;
 121
 122   /**
 123    * Actual traffic on this connection from the other peer to this peer.
 124    * Includes transport overhead.
 125    *
 126    * Unit: [bytes/second]
 127    */
 128   uint32_t utilization_in;
 129
 130   /**
 131    * Distance on network layer (required for distance-vector routing)
 132    * in hops.  Zero for direct connections (i.e. plain TCP/UDP).
 133    */
 134   unsigned int distance;
 135
 136   /**
 137    * Which network scope does the respective address belong to?
 138    * This property does not change.
 139    */
 140   enum GNUNET_ATS_Network_Type scope;
 141
 142 };
 143
 144
 145 /**
 146  * ATS performance characteristics for an address in
 147  * network byte order (for IPC).
 148  */
 149 struct GNUNET_ATS_PropertiesNBO
 150 {
 151
 152   /**
 153    * Actual traffic on this connection from this peer to the other peer.
 154    * Includes transport overhead.
 155    *
 156    * Unit: [bytes/second]
 157    */
 158   uint32_t utilization_out GNUNET_PACKED;
 159
 160   /**
 161    * Actual traffic on this connection from the other peer to this peer.
 162    * Includes transport overhead.
 163    *
 164    * Unit: [bytes/second]
 165    */
 166   uint32_t utilization_in GNUNET_PACKED;
 167
 168   /**
 169    * Which network scope does the respective address belong to?
 170    * This property does not change.
 171    */
 172   uint32_t scope GNUNET_PACKED;
 173
 174   /**
 175    * Distance on network layer (required for distance-vector routing)
 176    * in hops.  Zero for direct connections (i.e. plain TCP/UDP).
 177    */
 178   uint32_t distance GNUNET_PACKED;
 179
 180   /**
 181    * Delay.  Time between when the time packet is sent and the packet
 182    * arrives.  FOREVER if we did not measure yet.
 183    */
 184   struct GNUNET_TIME_RelativeNBO delay;
 185
 186 };
 187
 188
 189
 190 /* ********************* LAN Characterization library ************************ */
 191 /* Note: these functions do not really communicate with the ATS service */
 192
 193
 194 /**
 195  * Convert ATS properties from host to network byte order.
 196  *
 197  * @param nbo[OUT] value written
 198  * @param hbo value read
 199  */
 200 void
 201 GNUNET_ATS_properties_hton (struct GNUNET_ATS_PropertiesNBO *nbo,
 202                             const struct GNUNET_ATS_Properties *hbo);
 203
 204
 205 /**
 206  * Convert ATS properties from network to host byte order.
 207  *
 208  * @param hbo[OUT] value written
 209  * @param nbo value read
 210  */
 211 void
 212 GNUNET_ATS_properties_ntoh (struct GNUNET_ATS_Properties *hbo,
 213                             const struct GNUNET_ATS_PropertiesNBO *nbo);
 214
 215
 216
 217 /**
 218  * Convert a `enum GNUNET_ATS_Network_Type` to a string
 219  *
 220  * @param net the network type
 221  * @return a string or NULL if invalid
 222  */
 223 const char *
 224 GNUNET_ATS_print_network_type (enum GNUNET_ATS_Network_Type net);
 225
 226
 227 /**
 228  * Handle for the LAN Characterization library.
 229  */
 230 struct GNUNET_ATS_InterfaceScanner;
 231
 232
 233 /**
 234  * Returns where the address is located: loopback, LAN or WAN.
 235  *
 236  * @param is handle from #GNUNET_ATS_interface_scanner_init()
 237  * @param addr address
 238  * @param addrlen address length
 239  * @return type of the network the address belongs to
 240  */
 241 enum GNUNET_ATS_Network_Type
 242 GNUNET_ATS_scanner_address_get_type (struct GNUNET_ATS_InterfaceScanner *is,
 243                                      const struct sockaddr *addr,
 244                                      socklen_t addrlen);
 245
 246
 247 /**
 248  * Initialize the ATS address characterization client handle.
 249  *
 250  * @return scanner handle, NULL on error
 251  */
 252 struct GNUNET_ATS_InterfaceScanner *
 253 GNUNET_ATS_scanner_init (void);
 254
 255
 256 /**
 257  * Terminate interface scanner.
 258  *
 259  * @param is scanner we are done with
 260  */
 261 void
 262 GNUNET_ATS_scanner_done (struct GNUNET_ATS_InterfaceScanner *is);
 263
 264
 265
 266 /* ********************Connection Suggestion API ***************************** */
 267
 268 /**
 269  * Handle to the ATS subsystem for making suggestions about
 270  * connections the peer would like to have.
 271  */
 272 struct GNUNET_ATS_ConnectivityHandle;
 273
 274 /**
 275  * Handle for address suggestion requests.
 276  */
 277 struct GNUNET_ATS_ConnectivitySuggestHandle;
 278
 279
 280 /**
 281  * Initialize the ATS connectivity suggestion client handle.
 282  *
 283  * @param cfg configuration to use
 284  * @return ats connectivity handle, NULL on error
 285  */
 286 struct GNUNET_ATS_ConnectivityHandle *
 287 GNUNET_ATS_connectivity_init (const struct GNUNET_CONFIGURATION_Handle *cfg);
 288
 289
 290 /**
 291  * Shutdown ATS connectivity suggestion client.
 292  *
 293  * @param ch handle to destroy
 294  */
 295 void
 296 GNUNET_ATS_connectivity_done (struct GNUNET_ATS_ConnectivityHandle *ch);
 297
 298
 299 /**
 300  * We would like to establish a new connection with a peer.  ATS
 301  * should suggest a good address to begin with.
 302  *
 303  * @param ch handle
 304  * @param peer identity of the peer we need an address for
 305  * TODO: add argument to allow client to express 'strength's of request
 306  * @return suggestion handle, NULL if request is already pending
 307   */
 308 struct GNUNET_ATS_ConnectivitySuggestHandle *
 309 GNUNET_ATS_connectivity_suggest (struct GNUNET_ATS_ConnectivityHandle *ch,
 310                                  const struct GNUNET_PeerIdentity *peer);
 311
 312
 313 /**
 314  * We no longer care about being connected to a peer.
 315  *
 316  * @param sh handle
 317  */
 318 void
 319 GNUNET_ATS_connectivity_suggest_cancel (struct GNUNET_ATS_ConnectivitySuggestHandle *sh);
 320
 321
 322 /* ******************************** Scheduling API ***************************** */
 323
 324 /**
 325  * Handle to the ATS subsystem for bandwidth/transport scheduling information.
 326  */
 327 struct GNUNET_ATS_SchedulingHandle;
 328
 329 /**
 330  * Opaque session handle, defined by plugins.  Contents not known to ATS.
 331  * FIXME: This violates our naming conventions.
 332  */
 333 struct Session;
 334
 335 /**
 336  * Signature of a function called by ATS with the current bandwidth
 337  * and address preferences as determined by ATS.
 338  *
 339  * @param cls closure
 340  * @param peer for which we suggest an address, NULL if ATS connection died
 341  * @param address suggested address (including peer identity of the peer),
 342  *             may be NULL to signal disconnect from peer
 343  * @param session session to use, NULL to establish a new outgoing session
 344  * @param bandwidth_out assigned outbound bandwidth for the connection,
 345  *        0 to signal disconnect
 346  * @param bandwidth_in assigned inbound bandwidth for the connection,
 347  *        0 to signal disconnect
 348  */
 349 typedef void
 350 (*GNUNET_ATS_AddressSuggestionCallback) (void *cls,
 351                                          const struct GNUNET_PeerIdentity *peer,
 352                                          const struct GNUNET_HELLO_Address *address,
 353                                          struct Session *session,
 354                                          struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 355                                          struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
 356
 357
 358 /**
 359  * Initialize the ATS scheduling subsystem.
 360  *
 361  * @param cfg configuration to use
 362  * @param suggest_cb notification to call whenever the suggestation changed
 363  * @param suggest_cb_cls closure for @a suggest_cb
 364  * @return ats context
 365  */
 366 struct GNUNET_ATS_SchedulingHandle *
 367 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 368                             GNUNET_ATS_AddressSuggestionCallback suggest_cb,
 369                             void *suggest_cb_cls);
 370
 371
 372 /**
 373  * Client is done with ATS scheduling, release resources.
 374  *
 375  * @param sh handle to release
 376  */
 377 void
 378 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh);
 379
 380
 381 /**
 382  * Handle used within ATS to track an address.
 383  */
 384 struct GNUNET_ATS_AddressRecord;
 385
 386
 387 /**
 388  * We have a new address ATS should know. Addresses have to be added with this
 389  * function before they can be: updated, set in use and destroyed
 390  *
 391  * @param sh handle
 392  * @param address the address
 393  * @param session session handle (if available, i.e. for incoming connections)
 394  * @param prop performance data for the address
 395  * @return handle to the address representation inside ATS, NULL
 396  *         on error (i.e. ATS knows this exact address already, or
 397  *         address is invalid)
 398  */
 399 struct GNUNET_ATS_AddressRecord *
 400 GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
 401                         const struct GNUNET_HELLO_Address *address,
 402                         struct Session *session,
 403                         const struct GNUNET_ATS_Properties *prop);
 404
 405
 406 /**
 407  * An address was used to initiate a session.
 408  *
 409  * @param ar address record to update information for
 410  * @param session session handle
 411  */
 412 void
 413 GNUNET_ATS_address_add_session (struct GNUNET_ATS_AddressRecord *ar,
 414                                 struct Session *session);
 415
 416
 417 /**
 418  * A session was destroyed, disassociate it from the
 419  * given address record.  If this was an incoming
 420  * addess, destroy the address as well.
 421  *
 422  * @param ar address record to update information for
 423  * @param session session handle
 424  * @return #GNUNET_YES if the @a ar was destroyed because
 425  *                     it was an incoming address,
 426  *         #GNUNET_NO if the @ar was kept because we can
 427  *                    use it still to establish a new session
 428  */
 429 int
 430 GNUNET_ATS_address_del_session (struct GNUNET_ATS_AddressRecord *ar,
 431                                 struct Session *session);
 432
 433
 434 /**
 435  * We have updated performance statistics for a given address.  Note
 436  * that this function can be called for addresses that are currently
 437  * in use as well as addresses that are valid but not actively in use.
 438  * Furthermore, the peer may not even be connected to us right now (@a
 439  * session value of NULL used to signal disconnect, or somehow we
 440  * otherwise got updated on @a ats information).  Based on the
 441  * information provided, ATS may update bandwidth assignments and
 442  * suggest to switch addresses.
 443  *
 444  * @param ar address record to update information for
 445  * @param prop performance data for the address
 446  */
 447 void
 448 GNUNET_ATS_address_update (struct GNUNET_ATS_AddressRecord *ar,
 449                            const struct GNUNET_ATS_Properties *prop);
 450
 451
 452 /**
 453  * An address got destroyed, stop using it as a valid address.
 454  *
 455  * @param ar address record to destroy, it's validation has
 456  *           expired and ATS may no longer use it
 457  */
 458 void
 459 GNUNET_ATS_address_destroy (struct GNUNET_ATS_AddressRecord *ar);
 460
 461
 462
 463 /* ******************************** Performance API ***************************** */
 464
 465 /**
 466  * ATS Handle to obtain and/or modify performance information.
 467  */
 468 struct GNUNET_ATS_PerformanceHandle;
 469
 470 /**
 471  * Signature of a function that is called with QoS information about an address.
 472  *
 473  * @param cls closure
 474  * @param address the address, NULL if ATS service was disconnected or
 475  *        when the iteration is completed in the case of
 476  *        #GNUNET_ATS_performance_list_addresses()
 477  * @param address_active #GNUNET_YES if this address is actively used
 478  *        to maintain a connection to a peer;
 479  *        #GNUNET_NO if the address is not actively used;
 480  *        #GNUNET_SYSERR if this address is no longer available for ATS
 481  * @param bandwidth_out assigned outbound bandwidth for the connection
 482  * @param bandwidth_in assigned inbound bandwidth for the connection
 483  * @param prop performance data for the address
 484  */
 485 typedef void
 486 (*GNUNET_ATS_AddressInformationCallback) (void *cls,
 487                                           const struct GNUNET_HELLO_Address *address,
 488                                           int address_active,
 489                                           struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 490                                           struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 491                                           const struct GNUNET_ATS_Properties *prop);
 492
 493
 494 /**
 495  * Handle for an address listing operation
 496  */
 497 struct GNUNET_ATS_AddressListHandle;
 498
 499
 500 /**
 501  * Get handle to access performance API of the ATS subsystem.
 502  *
 503  * @param cfg configuration to use
 504  * @param addr_info_cb callback called when performance characteristics for
 505  *      an address change
 506  * @param addr_info_cb_cls closure for @a addr_info_cb
 507  * @return ats performance context
 508  */
 509 struct GNUNET_ATS_PerformanceHandle *
 510 GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 511                              GNUNET_ATS_AddressInformationCallback addr_info_cb,
 512                              void *addr_info_cb_cls);
 513
 514
 515 /**
 516  * Get information about addresses known to the ATS subsystem.
 517  *
 518  * @param handle the performance handle to use
 519  * @param peer peer idm can be NULL for all peers
 520  * @param all #GNUNET_YES to get information about all addresses or #GNUNET_NO to
 521  *        get only address currently used
 522  * @param infocb callback to call with the addresses,
 523  *        will callback with address == NULL when done
 524  * @param infocb_cls closure for @a infocb
 525  * @return handle to abort the operation
 526  */
 527 struct GNUNET_ATS_AddressListHandle *
 528 GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *handle,
 529                                        const struct GNUNET_PeerIdentity *peer,
 530                                        int all,
 531                                        GNUNET_ATS_AddressInformationCallback infocb,
 532                                        void *infocb_cls);
 533
 534
 535 /**
 536  * Cancel a pending address listing operation
 537  *
 538  * @param handle the `struct GNUNET_ATS_AddressListHandle` handle to cancel
 539  */
 540 void
 541 GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandle *handle);
 542
 543
 544 /**
 545  * Client is done using the ATS performance subsystem, release resources.
 546  *
 547  * @param ph handle
 548  */
 549 void
 550 GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph);
 551
 552
 553 /**
 554  * Function called with reservation result.
 555  *
 556  * @param cls closure
 557  * @param peer identifies the peer
 558  * @param amount set to the amount that was actually reserved or unreserved;
 559  *               either the full requested amount or zero (no partial reservations)
 560  * @param res_delay if the reservation could not be satisfied (amount was 0), how
 561  *        long should the client wait until re-trying?
 562  */
 563 typedef void
 564 (*GNUNET_ATS_ReservationCallback) (void *cls,
 565                                    const struct GNUNET_PeerIdentity *peer,
 566                                    int32_t amount,
 567                                    struct GNUNET_TIME_Relative res_delay);
 568
 569
 570 /**
 571  * Context that can be used to cancel a peer information request.
 572  */
 573 struct GNUNET_ATS_ReservationContext;
 574
 575
 576 /**
 577  * Reserve inbound bandwidth from the given peer.  ATS will look at
 578  * the current amount of traffic we receive from the peer and ensure
 579  * that the peer could add 'amount' of data to its stream.
 580  *
 581  * @param ph performance handle
 582  * @param peer identifies the peer
 583  * @param amount reserve N bytes for receiving, negative
 584  *                amounts can be used to undo a (recent) reservation;
 585  * @param rcb function to call with the resulting reservation information
 586  * @param rcb_cls closure for @a rcb
 587  * @return NULL on error
 588  * @deprecated will be replaced soon
 589  */
 590 struct GNUNET_ATS_ReservationContext *
 591 GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
 592                               const struct GNUNET_PeerIdentity *peer,
 593                               int32_t amount,
 594                               GNUNET_ATS_ReservationCallback rcb,
 595                               void *rcb_cls);
 596
 597
 598 /**
 599  * Cancel request for reserving bandwidth.
 600  *
 601  * @param rc context returned by the original GNUNET_ATS_reserve_bandwidth call
 602  */
 603 void
 604 GNUNET_ATS_reserve_bandwidth_cancel (struct GNUNET_ATS_ReservationContext *rc);
 605
 606
 607 /**
 608  * ATS preference types as array initializer
 609  */
 610 #define GNUNET_ATS_PreferenceType {GNUNET_ATS_PREFERENCE_BANDWIDTH, GNUNET_ATS_PREFERENCE_LATENCY, GNUNET_ATS_PREFERENCE_END}
 611
 612 /**
 613  * ATS preference types as string array initializer
 614  */
 615 #define GNUNET_ATS_PreferenceTypeString {"BANDWIDTH", "LATENCY", "END" }
 616
 617 /**
 618  * Enum defining all known preference categories.
 619  */
 620 enum GNUNET_ATS_PreferenceKind
 621 {
 622
 623   /**
 624    * Change the peer's bandwidth value (value per byte of bandwidth in
 625    * the goal function) to the given amount.  The argument is followed
 626    * by a double value giving the desired value (can be negative).
 627    * Preference changes are forgotten if peers disconnect.
 628    */
 629   GNUNET_ATS_PREFERENCE_BANDWIDTH = 0,
 630
 631   /**
 632    * Change the peer's latency value to the given amount.  The
 633    * argument is followed by a double value giving the desired value
 634    * (can be negative).  The absolute score in the goal function is
 635    * the inverse of the latency in microseconds (minimum: 1
 636    * microsecond) multiplied by the latency preferences.
 637    */
 638   GNUNET_ATS_PREFERENCE_LATENCY = 1,
 639
 640   /**
 641    * End of preference list.
 642    */
 643   GNUNET_ATS_PREFERENCE_END = 2
 644
 645 };
 646
 647
 648 /**
 649  * Convert a GNUNET_ATS_PreferenceType to a string
 650  *
 651  * @param type the preference type
 652  * @return a string or NULL if invalid
 653  */
 654 const char *
 655 GNUNET_ATS_print_preference_type (enum GNUNET_ATS_PreferenceKind type);
 656
 657
 658 /**
 659  * Change preferences for the given peer. Preference changes are forgotten if peers
 660  * disconnect.
 661  *
 662  * @param ph performance handle @param peer identifies the peer
 663  * @param ... #GNUNET_ATS_PREFERENCE_END-terminated specification of the
 664  * desired changes
 665  */
 666 void
 667 GNUNET_ATS_performance_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
 668                                           const struct GNUNET_PeerIdentity *peer,
 669                                           ...);
 670
 671
 672 /**
 673  * Application feedback on how good preference requirements are fulfilled
 674  * for the preferences included in the given time scope [now - scope .. now]
 675  *
 676  * An application notifies ATS if (and only if) it has feedback information
 677  * for specific properties. This values are valid until the feedback scores are
 678  * updated by the application.
 679  *
 680  * If the application has no feedback for this preference kind the application
 681  * will not explicitly call for this property and will not include it in this
 682  * function call.
 683  *
 684  * @param ph performance handle
 685  * @param scope the time interval this valid for: [now - scope .. now]
 686  * @param peer identifies the peer
 687  * @param ... #GNUNET_ATS_PREFERENCE_END-terminated specification of the desired changes
 688  */
 689 void
 690 GNUNET_ATS_performance_give_feedback (struct GNUNET_ATS_PerformanceHandle *ph,
 691                                       const struct GNUNET_PeerIdentity *peer,
 692                                       const struct GNUNET_TIME_Relative scope,
 693                                       ...);
 694
 695 #endif
 696 /* end of file gnunet-service-transport_ats.h */