2 This file is part of GNUnet.
3 Copyright (C) 2010-2015 Christian Grothoff (and other contributing authors)
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.
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.
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.
21 * @file include/gnunet_ats_service.h
22 * @brief automatic transport selection and outbound bandwidth determination
23 * @author Christian Grothoff
24 * @author Matthias Wachs
26 #ifndef GNUNET_ATS_SERVICE_H
27 #define GNUNET_ATS_SERVICE_H
29 #include "gnunet_constants.h"
30 #include "gnunet_util_lib.h"
31 #include "gnunet_hello_lib.h"
34 * Types of networks (with separate quotas) we support.
36 enum GNUNET_ATS_Network_Type
39 * Category of last resort.
41 GNUNET_ATS_NET_UNSPECIFIED = 0,
44 * Loopback (same host).
46 GNUNET_ATS_NET_LOOPBACK = 1,
51 GNUNET_ATS_NET_LAN = 2,
54 * Wide area network (i.e. Internet)
56 GNUNET_ATS_NET_WAN = 3,
59 * Wireless LAN (i.e. 802.11abgn)
61 GNUNET_ATS_NET_WLAN = 4,
69 * Number of network types supported by ATS
71 #define GNUNET_ATS_NetworkTypeCount 6
77 * Default bandwidth assigned to a network : 64 KB/s
79 #define GNUNET_ATS_DefaultBandwidth 65536
82 * Undefined value for an `enum GNUNET_ATS_Property`
84 #define GNUNET_ATS_VALUE_UNDEFINED UINT32_MAX
87 * String representation for GNUNET_ATS_VALUE_UNDEFINED
89 #define GNUNET_ATS_VALUE_UNDEFINED_STR "undefined"
92 * Maximum bandwidth assigned to a network : 4095 MB/s
94 #define GNUNET_ATS_MaxBandwidth UINT32_MAX
97 * Textual equivalent for GNUNET_ATS_MaxBandwidth
99 #define GNUNET_ATS_MaxBandwidthString "unlimited"
103 * Enum defining all known property types for ATS Enum values are used
104 * in the GNUNET_ATS_Information struct as
107 * Cost are always stored in uint32_t, so all units used to define costs
108 * have to be normalized to fit in uint32_t [0 .. UINT32_MAX-1]
110 * UINT32_MAX is reserved for uninitialized values #GNUNET_ATS_VALUE_UNDEFINED
112 enum GNUNET_ATS_Property
119 GNUNET_ATS_ARRAY_TERMINATOR = 0,
122 * Actual traffic on this connection from this peer to the other peer.
123 * Includes transport overhead
125 * Unit: [bytes/second]
127 GNUNET_ATS_UTILIZATION_OUT = 1,
130 * Actual traffic on this connection from the other peer to this peer.
131 * Includes transport overhead
133 * Unit: [bytes/second]
135 GNUNET_ATS_UTILIZATION_IN = 2,
138 * Is this address located in WAN, LAN or a loopback address
139 * Value is element of GNUNET_ATS_Network_Type
141 GNUNET_ATS_NETWORK_TYPE = 3,
145 * Time between when the time packet is sent and the packet arrives
147 * Unit: [microseconds]
155 GNUNET_ATS_QUALITY_NET_DELAY = 4,
158 * Distance on network layer (required for distance-vector routing).
162 GNUNET_ATS_QUALITY_NET_DISTANCE = 5
165 * Number of property types supported by ATS
167 #define GNUNET_ATS_PropertyCount 6
174 * Number of ATS quality properties
176 #define GNUNET_ATS_QualityPropertiesCount 2
179 * ATS quality properties as array initializer
181 #define GNUNET_ATS_QualityProperties { GNUNET_ATS_QUALITY_NET_DELAY, GNUNET_ATS_QUALITY_NET_DISTANCE }
184 * ATS quality properties as string array initializer
186 #define GNUNET_ATS_QualityPropertiesString {"Delay", "Distance"}
188 GNUNET_NETWORK_STRUCT_BEGIN
191 * struct used to communicate the transport's properties like cost and
192 * quality of service as well as high-level constraints on resource
196 * +-----------+ Constraints | | Plugin properties +---------+
197 * | Highlevel |------------> |ATS| <------------------|Transport|
198 * | Component | ATS struct | | ATS struct | Plugin |
199 * +-----------+ | | +---------+
202 * This structure will be used by transport plugins to communicate
203 * costs to ATS or by higher level components to tell ATS their
204 * constraints. Always a pair of (GNUNET_ATS_Property,
205 * uint32_t value). Value is always uint32_t, so all units used to
206 * define costs have to be normalized to fit uint32_t.
208 struct GNUNET_ATS_Information
211 * ATS property type, in network byte order.
213 uint32_t type GNUNET_PACKED;
216 * ATS property value, in network byte order.
218 uint32_t value GNUNET_PACKED;
220 GNUNET_NETWORK_STRUCT_END
223 /* ********************* LAN Characterization library ************************ */
224 /* Note: these functions do not really communicate with the ATS service */
227 * Convert a ATS property to a string
229 * @param type the property type
230 * @return a string or NULL if invalid
233 GNUNET_ATS_print_property_type (enum GNUNET_ATS_Property type);
237 * Convert a `enum GNUNET_ATS_Network_Type` to a string
239 * @param net the network type
240 * @return a string or NULL if invalid
243 GNUNET_ATS_print_network_type (enum GNUNET_ATS_Network_Type net);
247 * Handle for the LAN Characterization library.
249 struct GNUNET_ATS_InterfaceScanner;
253 * Returns where the address is located: loopback, LAN or WAN.
255 * @param is handle from #GNUNET_ATS_interface_scanner_init()
256 * @param addr address
257 * @param addrlen address length
258 * @return type of the network the address belongs to
260 enum GNUNET_ATS_Network_Type
261 GNUNET_ATS_scanner_address_get_type (struct GNUNET_ATS_InterfaceScanner *is,
262 const struct sockaddr *addr,
267 * Initialize the ATS address characterization client handle.
269 * @return scanner handle, NULL on error
271 struct GNUNET_ATS_InterfaceScanner *
272 GNUNET_ATS_scanner_init (void);
276 * Terminate interface scanner.
278 * @param is scanner we are done with
281 GNUNET_ATS_scanner_done (struct GNUNET_ATS_InterfaceScanner *is);
285 /* ********************Connection Suggestion API ***************************** */
288 * Handle to the ATS subsystem for making suggestions about
289 * connections the peer would like to have.
291 struct GNUNET_ATS_ConnectivityHandle;
294 * Handle for address suggestion requests.
296 struct GNUNET_ATS_ConnectivitySuggestHandle;
300 * Initialize the ATS connectivity suggestion client handle.
302 * @param cfg configuration to use
303 * @return ats connectivity handle, NULL on error
305 struct GNUNET_ATS_ConnectivityHandle *
306 GNUNET_ATS_connectivity_init (const struct GNUNET_CONFIGURATION_Handle *cfg);
310 * Shutdown ATS connectivity suggestion client.
312 * @param ch handle to destroy
315 GNUNET_ATS_connectivity_done (struct GNUNET_ATS_ConnectivityHandle *ch);
319 * We would like to establish a new connection with a peer. ATS
320 * should suggest a good address to begin with.
323 * @param peer identity of the peer we need an address for
324 * @return suggestion handle, NULL if request is already pending
326 struct GNUNET_ATS_ConnectivitySuggestHandle *
327 GNUNET_ATS_connectivity_suggest (struct GNUNET_ATS_ConnectivityHandle *ch,
328 const struct GNUNET_PeerIdentity *peer);
332 * We no longer care about being connected to a peer.
337 GNUNET_ATS_connectivity_suggest_cancel (struct GNUNET_ATS_ConnectivitySuggestHandle *sh);
340 /* ******************************** Scheduling API ***************************** */
343 * Handle to the ATS subsystem for bandwidth/transport scheduling information.
345 struct GNUNET_ATS_SchedulingHandle;
348 * Opaque session handle, defined by plugins. Contents not known to ATS.
353 * Signature of a function called by ATS with the current bandwidth
354 * and address preferences as determined by ATS.
357 * @param peer for which we suggest an address, NULL if ATS connection died
358 * @param address suggested address (including peer identity of the peer),
359 * may be NULL to signal disconnect from peer
360 * @param session session to use, NULL to establish a new outgoing session
361 * @param bandwidth_out assigned outbound bandwidth for the connection,
362 * 0 to signal disconnect
363 * @param bandwidth_in assigned inbound bandwidth for the connection,
364 * 0 to signal disconnect
367 (*GNUNET_ATS_AddressSuggestionCallback) (void *cls,
368 const struct GNUNET_PeerIdentity *peer,
369 const struct GNUNET_HELLO_Address *address,
370 struct Session *session,
371 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
372 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
376 * Initialize the ATS scheduling subsystem.
378 * @param cfg configuration to use
379 * @param suggest_cb notification to call whenever the suggestation changed
380 * @param suggest_cb_cls closure for @a suggest_cb
381 * @return ats context
383 struct GNUNET_ATS_SchedulingHandle *
384 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
385 GNUNET_ATS_AddressSuggestionCallback suggest_cb,
386 void *suggest_cb_cls);
390 * Client is done with ATS scheduling, release resources.
392 * @param sh handle to release
395 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh);
399 * Test if a address and a session is known to ATS.
401 * @param sh the scheduling handle
402 * @param address the address
403 * @param session the session
404 * @return #GNUNET_YES or #GNUNET_NO
407 GNUNET_ATS_session_known (struct GNUNET_ATS_SchedulingHandle *sh,
408 const struct GNUNET_HELLO_Address *address,
409 struct Session *session);
413 * Handle used within ATS to track an address.
415 struct GNUNET_ATS_AddressRecord;
419 * We have a new address ATS should know. Addresses have to be added with this
420 * function before they can be: updated, set in use and destroyed
423 * @param address the address
424 * @param session session handle (if available, i.e. for incoming connections)
425 * @param ats performance data for the address
426 * @param ats_count number of performance records in @a ats
427 * @return handle to the address representation inside ATS, NULL
428 * on error (i.e. ATS knows this exact address already, or
429 * address is invalid)
431 struct GNUNET_ATS_AddressRecord *
432 GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
433 const struct GNUNET_HELLO_Address *address,
434 struct Session *session,
435 const struct GNUNET_ATS_Information *ats,
440 * An address was used to initiate a session.
442 * @param ar address record to update information for
443 * @param session session handle
446 GNUNET_ATS_address_add_session (struct GNUNET_ATS_AddressRecord *ar,
447 struct Session *session);
451 * A session was destroyed, disassociate it from the
452 * given address record. If this was an incoming
453 * addess, destroy the address as well.
455 * @param ar address record to update information for
456 * @param session session handle
457 * @return #GNUNET_YES if the @a ar was destroyed because
458 * it was an incoming address,
459 * #GNUNET_NO if the @ar was kept because we can
460 * use it still to establish a new session
463 GNUNET_ATS_address_del_session (struct GNUNET_ATS_AddressRecord *ar,
464 struct Session *session);
468 * We have updated performance statistics for a given address. Note
469 * that this function can be called for addresses that are currently
470 * in use as well as addresses that are valid but not actively in use.
471 * Furthermore, the peer may not even be connected to us right now (@a
472 * session value of NULL used to signal disconnect, or somehow we
473 * otherwise got updated on @a ats information). Based on the
474 * information provided, ATS may update bandwidth assignments and
475 * suggest to switch addresses.
477 * @param ar address record to update information for
478 * @param ats performance data for the address
479 * @param ats_count number of performance records in @a ats
482 GNUNET_ATS_address_update (struct GNUNET_ATS_AddressRecord *ar,
483 const struct GNUNET_ATS_Information *ats,
488 * An address got destroyed, stop using it as a valid address.
490 * @param ar address record to destroy, it's validation has
491 * expired and ATS may no longer use it
494 GNUNET_ATS_address_destroy (struct GNUNET_ATS_AddressRecord *ar);
498 /* ******************************** Performance API ***************************** */
501 * ATS Handle to obtain and/or modify performance information.
503 struct GNUNET_ATS_PerformanceHandle;
506 * Signature of a function that is called with QoS information about an address.
509 * @param address the address, NULL if ATS service was disconnected
510 * @param address_active #GNUNET_YES if this address is actively used
511 * to maintain a connection to a peer;
512 * #GNUNET_NO if the address is not actively used;
513 * #GNUNET_SYSERR if this address is no longer available for ATS
514 * @param bandwidth_out assigned outbound bandwidth for the connection
515 * @param bandwidth_in assigned inbound bandwidth for the connection
516 * @param ats performance data for the address (as far as known)
517 * @param ats_count number of performance records in @a ats
520 (*GNUNET_ATS_AddressInformationCallback) (void *cls,
521 const struct GNUNET_HELLO_Address *address,
523 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
524 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
525 const struct GNUNET_ATS_Information *ats,
530 * Handle for an address listing operation
532 struct GNUNET_ATS_AddressListHandle;
536 * Get handle to access performance API of the ATS subsystem.
538 * @param cfg configuration to use
539 * @param addr_info_cb callback called when performance characteristics for
541 * @param addr_info_cb_cls closure for @a addr_info_cb
542 * @return ats performance context
544 struct GNUNET_ATS_PerformanceHandle *
545 GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
546 GNUNET_ATS_AddressInformationCallback addr_info_cb,
547 void *addr_info_cb_cls);
552 * Get information about addresses known to the ATS subsystem.
554 * @param handle the performance handle to use
555 * @param peer peer idm can be NULL for all peers
556 * @param all #GNUNET_YES to get information about all addresses or #GNUNET_NO to
557 * get only address currently used
558 * @param infocb callback to call with the addresses,
559 * will callback with address == NULL when done
560 * @param infocb_cls closure for @a infocb
561 * @return ats performance context
563 struct GNUNET_ATS_AddressListHandle *
564 GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *handle,
565 const struct GNUNET_PeerIdentity *peer,
567 GNUNET_ATS_AddressInformationCallback infocb,
572 * Cancel a pending address listing operation
574 * @param handle the `struct GNUNET_ATS_AddressListHandle` handle to cancel
577 GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandle *handle);
581 * Client is done using the ATS performance subsystem, release resources.
586 GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph);
590 * Function called with reservation result.
593 * @param peer identifies the peer
594 * @param amount set to the amount that was actually reserved or unreserved;
595 * either the full requested amount or zero (no partial reservations)
596 * @param res_delay if the reservation could not be satisfied (amount was 0), how
597 * long should the client wait until re-trying?
600 (*GNUNET_ATS_ReservationCallback) (void *cls,
601 const struct GNUNET_PeerIdentity *peer,
603 struct GNUNET_TIME_Relative res_delay);
607 * Context that can be used to cancel a peer information request.
609 struct GNUNET_ATS_ReservationContext;
613 * Reserve inbound bandwidth from the given peer. ATS will look at
614 * the current amount of traffic we receive from the peer and ensure
615 * that the peer could add 'amount' of data to its stream.
617 * @param ph performance handle
618 * @param peer identifies the peer
619 * @param amount reserve N bytes for receiving, negative
620 * amounts can be used to undo a (recent) reservation;
621 * @param rcb function to call with the resulting reservation information
622 * @param rcb_cls closure for @a rcb
623 * @return NULL on error
624 * @deprecated will be replaced soon
626 struct GNUNET_ATS_ReservationContext *
627 GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
628 const struct GNUNET_PeerIdentity *peer,
630 GNUNET_ATS_ReservationCallback rcb,
635 * Cancel request for reserving bandwidth.
637 * @param rc context returned by the original GNUNET_ATS_reserve_bandwidth call
640 GNUNET_ATS_reserve_bandwidth_cancel (struct GNUNET_ATS_ReservationContext *rc);
644 * ATS preference types as array initializer
646 #define GNUNET_ATS_PreferenceType {GNUNET_ATS_PREFERENCE_END, GNUNET_ATS_PREFERENCE_BANDWIDTH, GNUNET_ATS_PREFERENCE_LATENCY}
649 * ATS preference types as string array initializer
651 #define GNUNET_ATS_PreferenceTypeString {"END", "BANDWIDTH", "LATENCY"}
654 * Enum defining all known preference categories.
656 enum GNUNET_ATS_PreferenceKind
660 * End of preference list.
662 GNUNET_ATS_PREFERENCE_END = 0,
665 * Change the peer's bandwidth value (value per byte of bandwidth in
666 * the goal function) to the given amount. The argument is followed
667 * by a double value giving the desired value (can be negative).
668 * Preference changes are forgotten if peers disconnect.
670 GNUNET_ATS_PREFERENCE_BANDWIDTH = 1,
673 * Change the peer's latency value to the given amount. The
674 * argument is followed by a double value giving the desired value
675 * (can be negative). The absolute score in the goal function is
676 * the inverse of the latency in microseconds (minimum: 1
677 * microsecond) multiplied by the latency preferences.
679 GNUNET_ATS_PREFERENCE_LATENCY = 2
682 * Number of preference types supported by ATS
684 #define GNUNET_ATS_PreferenceCount 3
691 * Convert a GNUNET_ATS_PreferenceType to a string
693 * @param type the preference type
694 * @return a string or NULL if invalid
697 GNUNET_ATS_print_preference_type (enum GNUNET_ATS_PreferenceKind type);
701 * Change preferences for the given peer. Preference changes are forgotten if peers
704 * @param ph performance handle
705 * @param peer identifies the peer
706 * @param ... 0-terminated specification of the desired changes
709 GNUNET_ATS_performance_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
710 const struct GNUNET_PeerIdentity *peer,
715 * Application feedback on how good preference requirements are fulfilled
716 * for the preferences included in the given time scope [now - scope .. now]
718 * An application notifies ATS if (and only if) it has feedback information
719 * for specific properties. This values are valid until the feedback scores are
720 * updated by the application.
722 * If the application has no feedback for this preference kind the application
723 * will not explicitly call for this property and will not include it in this
726 * @param ph performance handle
727 * @param scope the time interval this valid for: [now - scope .. now]
728 * @param peer identifies the peer
729 * @param ... 0-terminated specification of the desired changes
732 GNUNET_ATS_performance_give_feedback (struct GNUNET_ATS_PerformanceHandle *ph,
733 const struct GNUNET_PeerIdentity *peer,
734 const struct GNUNET_TIME_Relative scope,
738 /* end of file gnunet-service-transport_ats.h */