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 * ATS performance characteristics for an address.
105 struct GNUNET_ATS_Properties
109 * Actual traffic on this connection from this peer to the other peer.
110 * Includes transport overhead.
112 * Unit: [bytes/second]
114 uint32_t utilization_out;
117 * Actual traffic on this connection from the other peer to this peer.
118 * Includes transport overhead.
120 * Unit: [bytes/second]
122 uint32_t utilization_in;
125 * Which network scope does the respective address belong to?
126 * This property does not change.
128 enum GNUNET_ATS_Network_Type scope;
131 * Distance on network layer (required for distance-vector routing)
132 * in hops. Zero for direct connections (i.e. plain TCP/UDP).
134 unsigned int distance;
137 * Delay. Time between when the time packet is sent and the packet
138 * arrives. FOREVER if we did not measure yet.
140 struct GNUNET_TIME_Relative delay;
146 * ATS performance characteristics for an address in
147 * network byte order (for IPC).
149 struct GNUNET_ATS_PropertiesNBO
153 * Actual traffic on this connection from this peer to the other peer.
154 * Includes transport overhead.
156 * Unit: [bytes/second]
158 uint32_t utilization_out GNUNET_PACKED;
161 * Actual traffic on this connection from the other peer to this peer.
162 * Includes transport overhead.
164 * Unit: [bytes/second]
166 uint32_t utilization_in GNUNET_PACKED;
169 * Which network scope does the respective address belong to?
170 * This property does not change.
172 uint32_t scope GNUNET_PACKED;
175 * Distance on network layer (required for distance-vector routing)
176 * in hops. Zero for direct connections (i.e. plain TCP/UDP).
178 uint32_t distance GNUNET_PACKED;
181 * Delay. Time between when the time packet is sent and the packet
182 * arrives. FOREVER if we did not measure yet.
184 struct GNUNET_TIME_RelativeNBO delay;
190 /* ********************* LAN Characterization library ************************ */
191 /* Note: these functions do not really communicate with the ATS service */
195 * Convert ATS properties from host to network byte order.
197 * @param nbo[OUT] value written
198 * @param hbo value read
201 GNUNET_ATS_properties_hton (struct GNUNET_ATS_PropertiesNBO *nbo,
202 const struct GNUNET_ATS_Properties *hbo);
206 * Convert ATS properties from network to host byte order.
208 * @param hbo[OUT] value written
209 * @param nbo value read
212 GNUNET_ATS_properties_ntoh (struct GNUNET_ATS_Properties *hbo,
213 const struct GNUNET_ATS_PropertiesNBO *nbo);
218 * Convert a `enum GNUNET_ATS_Network_Type` to a string
220 * @param net the network type
221 * @return a string or NULL if invalid
224 GNUNET_ATS_print_network_type (enum GNUNET_ATS_Network_Type net);
228 * Handle for the LAN Characterization library.
230 struct GNUNET_ATS_InterfaceScanner;
234 * Returns where the address is located: loopback, LAN or WAN.
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
241 enum GNUNET_ATS_Network_Type
242 GNUNET_ATS_scanner_address_get_type (struct GNUNET_ATS_InterfaceScanner *is,
243 const struct sockaddr *addr,
248 * Initialize the ATS address characterization client handle.
250 * @return scanner handle, NULL on error
252 struct GNUNET_ATS_InterfaceScanner *
253 GNUNET_ATS_scanner_init (void);
257 * Terminate interface scanner.
259 * @param is scanner we are done with
262 GNUNET_ATS_scanner_done (struct GNUNET_ATS_InterfaceScanner *is);
266 /* ********************Connection Suggestion API ***************************** */
269 * Handle to the ATS subsystem for making suggestions about
270 * connections the peer would like to have.
272 struct GNUNET_ATS_ConnectivityHandle;
275 * Handle for address suggestion requests.
277 struct GNUNET_ATS_ConnectivitySuggestHandle;
281 * Initialize the ATS connectivity suggestion client handle.
283 * @param cfg configuration to use
284 * @return ats connectivity handle, NULL on error
286 struct GNUNET_ATS_ConnectivityHandle *
287 GNUNET_ATS_connectivity_init (const struct GNUNET_CONFIGURATION_Handle *cfg);
291 * Shutdown ATS connectivity suggestion client.
293 * @param ch handle to destroy
296 GNUNET_ATS_connectivity_done (struct GNUNET_ATS_ConnectivityHandle *ch);
300 * We would like to establish a new connection with a peer. ATS
301 * should suggest a good address to begin with.
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
308 struct GNUNET_ATS_ConnectivitySuggestHandle *
309 GNUNET_ATS_connectivity_suggest (struct GNUNET_ATS_ConnectivityHandle *ch,
310 const struct GNUNET_PeerIdentity *peer);
314 * We no longer care about being connected to a peer.
319 GNUNET_ATS_connectivity_suggest_cancel (struct GNUNET_ATS_ConnectivitySuggestHandle *sh);
322 /* ******************************** Scheduling API ***************************** */
325 * Handle to the ATS subsystem for bandwidth/transport scheduling information.
327 struct GNUNET_ATS_SchedulingHandle;
330 * Opaque session handle, defined by plugins. Contents not known to ATS.
331 * FIXME: This violates our naming conventions.
336 * Signature of a function called by ATS with the current bandwidth
337 * and address preferences as determined by ATS.
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
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);
359 * Initialize the ATS scheduling subsystem.
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
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);
373 * Client is done with ATS scheduling, release resources.
375 * @param sh handle to release
378 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh);
382 * Handle used within ATS to track an address.
384 struct GNUNET_ATS_AddressRecord;
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
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)
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);
407 * An address was used to initiate a session.
409 * @param ar address record to update information for
410 * @param session session handle
413 GNUNET_ATS_address_add_session (struct GNUNET_ATS_AddressRecord *ar,
414 struct Session *session);
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.
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
430 GNUNET_ATS_address_del_session (struct GNUNET_ATS_AddressRecord *ar,
431 struct Session *session);
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.
444 * @param ar address record to update information for
445 * @param prop performance data for the address
448 GNUNET_ATS_address_update (struct GNUNET_ATS_AddressRecord *ar,
449 const struct GNUNET_ATS_Properties *prop);
453 * An address got destroyed, stop using it as a valid address.
455 * @param ar address record to destroy, it's validation has
456 * expired and ATS may no longer use it
459 GNUNET_ATS_address_destroy (struct GNUNET_ATS_AddressRecord *ar);
463 /* ******************************** Performance API ***************************** */
466 * ATS Handle to obtain and/or modify performance information.
468 struct GNUNET_ATS_PerformanceHandle;
471 * Signature of a function that is called with QoS information about an address.
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
486 (*GNUNET_ATS_AddressInformationCallback) (void *cls,
487 const struct GNUNET_HELLO_Address *address,
489 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
490 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
491 const struct GNUNET_ATS_Properties *prop);
495 * Handle for an address listing operation
497 struct GNUNET_ATS_AddressListHandle;
501 * Get handle to access performance API of the ATS subsystem.
503 * @param cfg configuration to use
504 * @param addr_info_cb callback called when performance characteristics for
506 * @param addr_info_cb_cls closure for @a addr_info_cb
507 * @return ats performance context
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);
516 * Get information about addresses known to the ATS subsystem.
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
527 struct GNUNET_ATS_AddressListHandle *
528 GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *handle,
529 const struct GNUNET_PeerIdentity *peer,
531 GNUNET_ATS_AddressInformationCallback infocb,
536 * Cancel a pending address listing operation
538 * @param handle the `struct GNUNET_ATS_AddressListHandle` handle to cancel
541 GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandle *handle);
545 * Client is done using the ATS performance subsystem, release resources.
550 GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph);
554 * Function called with reservation result.
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?
564 (*GNUNET_ATS_ReservationCallback) (void *cls,
565 const struct GNUNET_PeerIdentity *peer,
567 struct GNUNET_TIME_Relative res_delay);
571 * Context that can be used to cancel a peer information request.
573 struct GNUNET_ATS_ReservationContext;
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.
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
590 struct GNUNET_ATS_ReservationContext *
591 GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
592 const struct GNUNET_PeerIdentity *peer,
594 GNUNET_ATS_ReservationCallback rcb,
599 * Cancel request for reserving bandwidth.
601 * @param rc context returned by the original GNUNET_ATS_reserve_bandwidth call
604 GNUNET_ATS_reserve_bandwidth_cancel (struct GNUNET_ATS_ReservationContext *rc);
608 * ATS preference types as array initializer
610 #define GNUNET_ATS_PreferenceType {GNUNET_ATS_PREFERENCE_END, GNUNET_ATS_PREFERENCE_BANDWIDTH, GNUNET_ATS_PREFERENCE_LATENCY}
613 * ATS preference types as string array initializer
615 #define GNUNET_ATS_PreferenceTypeString {"BANDWIDTH", "LATENCY", "END" }
618 * Enum defining all known preference categories.
620 enum GNUNET_ATS_PreferenceKind
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.
629 GNUNET_ATS_PREFERENCE_BANDWIDTH = 0,
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.
638 GNUNET_ATS_PREFERENCE_LATENCY = 1,
641 * End of preference list.
643 GNUNET_ATS_PREFERENCE_END = 2
649 * Convert a GNUNET_ATS_PreferenceType to a string
651 * @param type the preference type
652 * @return a string or NULL if invalid
655 GNUNET_ATS_print_preference_type (enum GNUNET_ATS_PreferenceKind type);
659 * Change preferences for the given peer. Preference changes are forgotten if peers
662 * @param ph performance handle @param peer identifies the peer
663 * @param ... #GNUNET_ATS_PREFERENCE_END-terminated specification of the
667 GNUNET_ATS_performance_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
668 const struct GNUNET_PeerIdentity *peer,
673 * Application feedback on how good preference requirements are fulfilled
674 * for the preferences included in the given time scope [now - scope .. now]
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.
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
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
690 GNUNET_ATS_performance_give_feedback (struct GNUNET_ATS_PerformanceHandle *ph,
691 const struct GNUNET_PeerIdentity *peer,
692 const struct GNUNET_TIME_Relative scope,
696 /* end of file gnunet-service-transport_ats.h */