2 This file is part of GNUnet.
3 (C) 2010,2011 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 enum GNUNET_ATS_Network_Type
36 GNUNET_ATS_NET_UNSPECIFIED = 0,
37 GNUNET_ATS_NET_LOOPBACK = 1,
38 GNUNET_ATS_NET_LAN = 2,
39 GNUNET_ATS_NET_WAN = 3,
40 GNUNET_ATS_NET_WLAN = 4,
44 * Enum defining all known property types for ATS Enum values are used
45 * in the GNUNET_ATS_Information struct as
48 * Cost are always stored in uint32_t, so all units used to define costs
49 * have to be normalized to fit in uint32_t [0 .. 4.294.967.295]
51 enum GNUNET_ATS_Property
58 GNUNET_ATS_ARRAY_TERMINATOR = 0,
61 * Actual traffic on this connection from the other peer to this peer.
63 * Unit: [bytes/second]
65 GNUNET_ATS_UTILIZATION_UP,
68 * Actual traffic on this connection from this peer to the other peer.
70 * Unit: [bytes/second]
72 GNUNET_ATS_UTILIZATION_DOWN,
75 * Is this address located in WAN, LAN or a loopback address
76 * Value is element of GNUNET_ATS_Network_Type
78 GNUNET_ATS_NETWORK_TYPE,
82 * Time between when the time packet is sent and the packet arrives
92 GNUNET_ATS_QUALITY_NET_DELAY,
95 * Distance on network layer (required for distance-vector routing).
99 GNUNET_ATS_QUALITY_NET_DISTANCE,
102 * Network overhead on WAN (Wide-Area Network)
104 * How many bytes are sent on the WAN when 1 kilobyte (1024 bytes)
105 * of application data is transmitted?
106 * A factor used with connect cost, bandwidth cost and energy cost
107 * to describe the overhead produced by the transport protocol
111 * Interpretation: less is better
115 * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
116 * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
117 * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb]
118 * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb]
123 * Network overhead on LAN (Local-Area Network)
125 * How many bytes are sent on the LAN when 1 kilobyte (1024 bytes)
126 * of application data is transmitted?
127 * A factor used with connect cost, bandwidth cost and energy cost
128 * to describe the overhead produced by the transport protocol
132 * Interpretation: less is better
136 * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
137 * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
138 * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb]
139 * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb]
144 * Network overhead on WLAN (Wireless Local Area Network)
146 * How many bytes are sent on the LAN when 1 kilobyte (1024 bytes)
147 * of application data is transmitted?
148 * A factor used with connect cost, bandwidth cost and energy cost
149 * to describe the overhead produced by the transport protocol
153 * Interpretation: less is better
157 * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
158 * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
159 * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb]
160 * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb]
163 /* Cost related values */
164 /* =================== */
166 * Volume based cost in financial units to transmit data
168 * Note: This value is not bound to a specific currency or unit and only
170 * "cent" just refers the smallest amount of money in the respective
175 * Interpretation: less is better
181 // GNUNET_ATS_COST_FINANCIAL_PER_VOLUME = 1,
183 * Time based cost in financial units to transmit data
185 * Note: This value is not bound to a specific currency or unit and only
187 * "cent" just refers the smallest amount of money in the respective
192 * Interpretation: less is better
196 * Dialup: 10 [cent/h]
198 // GNUNET_ATS_COST_FINANCIAL_PER_TIME = 2,
200 * Computational costs
202 * Effort of preparing data to be sent with this transport
203 * Includes encoding, encryption and conversion of data
204 * Partial values can be summed up: c_sum = c_enc + c_enc + c_conv
205 * Resulting values depend on local system properties, e.g. CPU
209 * Interpretation: less is better
213 * HTTPS with AES CBC-256: 7,382
214 * HTTPS with AES CBC-128: 5,279
215 * HTTPS with RC4-1024: 2,652
217 // GNUNET_ATS_COST_COMPUTATIONAL = 3,
221 * Energy consumption using this transport when sending with a certain
222 * power at a certain bitrate. This is only an approximation based on:
223 * Energy consumption E = P / D
226 * Power P in Watt (J/s)
227 * Datarate D in MBit/s
229 * Conversion between power P and dBm used by WLAN in radiotap's dBm TX power:
231 * Lp(dbm) = 10 log10 (P/ 1mW)
233 * => P = 1 mW * 10^(Lp(dbm)/10)
237 * Interpretation: less is better
242 * WLAN: 89 (600 mW @ 802.11g /w 54 MBit/s)
243 * Bluetooth: 267 (100 mW @ BT2.0 EDR /w 3 MBit/s)
245 // GNUNET_ATS_COST_ENERGY_CONSUMPTION = 4,
248 * How many bytes are transmitted to initiate a new connection using
253 * Interpretation: less is better
257 * UDP (No connection) :
259 * TCP (TCP 3-Way handshake):
260 * 220 bytes Ethernet, 172 bytes TCP/IP, 122 bytes TCP
261 * HTTP (TCP + Header) :
262 * 477 bytes Ethernet, 429 bytes TCP/IP, 374 bytes TCP, 278 bytes HTTP
263 * HTTPS HTTP+TLS Handshake:
264 * 2129 bytes Ethernet, 1975 bytes TCP/IP, 1755 bytes TCP, 1403 bytes HTTPS
267 // GNUNET_ATS_COST_CONNECT = 5,
271 * How many bandwidth is available to consume?
272 * Used to calculate which impact sending data with this transport has
276 * Interpretation: more is better
279 * LAN: 12,800 (100 MBit/s)
280 * WLAN: 6,912 (54 MBit/s)
281 * Dial-up: 8 (64 Kbit/s)
284 // GNUNET_ATS_COST_BANDWITH_AVAILABLE = 6,
288 * How many bytes are sent over the wire when 1 kilobyte (1024 bytes)
289 * of application data is transmitted?
290 * A factor used with connect cost, bandwidth cost and energy cost
291 * to describe the overhead produced by the transport protocol
295 * Interpretation: less is better
299 * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
300 * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
301 * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb]
302 * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb]
304 // GNUNET_ATS_COST_NETWORK_OVERHEAD = 7,
305 /* Quality related values */
306 /* ====================== */
307 /* Physical layer quality properties */
309 * Signal strength on physical layer
313 // GNUNET_ATS_QUALITY_PHY_SIGNAL_STRENGTH = 1025,
315 * Collision rate on physical layer
319 // GNUNET_ATS_QUALITY_PHY_COLLISION_RATE = 1026,
321 * Error rate on physical layer
325 // GNUNET_ATS_QUALITY_PHY_ERROR_RATE = 1027,
328 * Time variations of the delay
329 * 1st derivative of a delay function
333 // GNUNET_ATS_QUALITY_NET_JITTER = 1029,
335 * Error rate on network layer
344 * Note: This numbers are just assumptions as an example, not
345 * measured or somehow determined
347 // GNUNET_ATS_QUALITY_NET_ERRORRATE = 1030,
349 * Drop rate on network layer
350 * Bytes actively dismissed by a network component during transmission
351 * Reasons for dropped data can be full queues, congestion, quota violations...
360 * Note: This numbers are just assumptions as an example, not
361 * measured or somehow determined
363 // GNUNET_ATS_QUALITY_NET_DROPRATE = 1031,
365 * Loss rate on network layer
366 * Bytes lost during transmission
367 * Reasons can be collisions, ...
376 * Note: This numbers are just assumptions as an example, not measured
377 * or somehow determined
379 // GNUNET_ATS_QUALITY_NET_LOSSRATE = 1032,
381 * Throughput on network layer
392 // GNUNET_ATS_QUALITY_NET_THROUGHPUT = 1033,
393 /* Availability related values */
394 /* =========================== */
396 * Is a peer reachable?
398 // GNUNET_ATS_AVAILABILITY_REACHABLE = 2048,
400 * Is there a connection established to a peer using this transport
402 // GNUNET_ATS_AVAILABILITY_CONNECTED = 2049
406 * Number of ATS quality properties
408 #define GNUNET_ATS_QualityPropertiesCount 2
411 * ATS quality properties as array initializer
413 #define GNUNET_ATS_QualityProperties {GNUNET_ATS_QUALITY_NET_DELAY, GNUNET_ATS_QUALITY_NET_DISTANCE}
416 * Number of ATS quality properties
418 #define GNUNET_ATS_NetworkTypeCount 5
421 * ATS quality properties as array initializer
423 #define GNUNET_ATS_NetworkType {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
425 GNUNET_NETWORK_STRUCT_BEGIN
428 * struct used to communicate the transport's properties like cost and
429 * quality of service as well as high-level constraints on resource
433 * +-----------+ Constraints | | Plugin properties +---------+
434 * | Highlevel |------------> |ATS| <------------------|Transport|
435 * | Component | ATS struct | | ATS struct | Plugin |
436 * +-----------+ | | +---------+
439 * This structure will be used by transport plugins to communicate
440 * costs to ATS or by higher level components to tell ATS their
441 * constraints. Always a pair of (GNUNET_ATS_Property,
442 * uint32_t value). Value is always uint32_t, so all units used to
443 * define costs have to be normalized to fit uint32_t.
445 struct GNUNET_ATS_Information
448 * ATS property type, in network byte order.
450 uint32_t type GNUNET_PACKED;
453 * ATS property value, in network byte order.
455 uint32_t value GNUNET_PACKED;
457 GNUNET_NETWORK_STRUCT_END
460 /* ******************************** Scheduling API ***************************** */
463 * Handle to the ATS subsystem for bandwidth/transport scheduling information.
465 struct GNUNET_ATS_SchedulingHandle;
469 * Opaque session handle, defined by plugins. Contents not known to ATS.
475 * Signature of a function called by ATS with the current bandwidth
476 * and address preferences as determined by ATS.
479 * @param address suggested address (including peer identity of the peer)
480 * @param session session to use
481 * @param bandwidth_out assigned outbound bandwidth for the connection
482 * @param bandwidth_in assigned inbound bandwidth for the connection
483 * @param ats performance data for the address (as far as known)
484 * @param ats_count number of performance records in 'ats'
486 typedef void (*GNUNET_ATS_AddressSuggestionCallback) (void *cls,
488 GNUNET_HELLO_Address *
490 struct Session * session,
492 GNUNET_BANDWIDTH_Value32NBO
495 GNUNET_BANDWIDTH_Value32NBO
498 GNUNET_ATS_Information *
499 ats, uint32_t ats_count);
503 * Initialize the ATS subsystem.
505 * @param cfg configuration to use
506 * @param suggest_cb notification to call whenever the suggestation changed
507 * @param suggest_cb_cls closure for 'suggest_cb'
508 * @return ats context
510 struct GNUNET_ATS_SchedulingHandle *
511 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
512 GNUNET_ATS_AddressSuggestionCallback suggest_cb,
513 void *suggest_cb_cls);
517 * Client is done with ATS scheduling, release resources.
519 * @param sh handle to release
522 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh);
526 * We would like to reset the address suggestion block time for this
530 * @param peer identity of the peer we want to reset
533 GNUNET_ATS_reset_backoff (struct GNUNET_ATS_SchedulingHandle *sh,
534 const struct GNUNET_PeerIdentity *peer);
537 * We would like to establish a new connection with a peer. ATS
538 * should suggest a good address to begin with.
541 * @param peer identity of the peer we need an address for
544 GNUNET_ATS_suggest_address (struct GNUNET_ATS_SchedulingHandle *sh,
545 const struct GNUNET_PeerIdentity *peer);
549 * We want to cancel ATS suggesting addresses for a peer.
552 * @param peer identity of the peer
555 GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SchedulingHandle *sh,
556 const struct GNUNET_PeerIdentity *peer);
560 * Returns where the address is located: LAN or WAN or ...
561 * @param sh the GNUNET_ATS_SchedulingHandle handle
562 * @param addr address
563 * @param addrlen address length
564 * @return location as GNUNET_ATS_Information
566 struct GNUNET_ATS_Information
567 GNUNET_ATS_address_get_type (struct GNUNET_ATS_SchedulingHandle *sh,
568 const struct sockaddr * addr,
572 * We have a new address ATS should know. Addresses have to be added with this
573 * function before they can be: updated, set in use and destroyed
576 * @param address the address
577 * @param session session handle (if available)
578 * @param ats performance data for the address
579 * @param ats_count number of performance records in 'ats'
582 GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
583 const struct GNUNET_HELLO_Address *address,
584 struct Session *session,
585 const struct GNUNET_ATS_Information *ats,
590 * We have updated performance statistics for a given address. Note
591 * that this function can be called for addresses that are currently
592 * in use as well as addresses that are valid but not actively in use.
593 * Furthermore, the peer may not even be connected to us right now (in
594 * which case the call may be ignored or the information may be stored
595 * for later use). Update bandwidth assignments.
598 * @param address updated address
599 * @param session session handle (if available)
600 * @param ats performance data for the address
601 * @param ats_count number of performance records in 'ats'
604 GNUNET_ATS_address_update (struct GNUNET_ATS_SchedulingHandle *sh,
605 const struct GNUNET_HELLO_Address *address,
606 struct Session *session,
607 const struct GNUNET_ATS_Information *ats,
612 * An address is now in use or not used any more.
615 * @param address the address
616 * @param session session handle
617 * @param in_use GNUNET_YES if this address is now used, GNUNET_NO
618 * if address is not used any more
621 GNUNET_ATS_address_in_use (struct GNUNET_ATS_SchedulingHandle *sh,
622 const struct GNUNET_HELLO_Address *address,
623 struct Session *session, int in_use);
627 * A session got destroyed, stop including it as a valid address.
630 * @param address the address
631 * @param session session handle that is no longer valid (if available)
634 GNUNET_ATS_address_destroyed (struct GNUNET_ATS_SchedulingHandle *sh,
635 const struct GNUNET_HELLO_Address *address,
636 struct Session *session);
639 /* ******************************** Performance API ***************************** */
642 * ATS Handle to obtain and/or modify performance information.
644 struct GNUNET_ATS_PerformanceHandle;
648 * Signature of a function that is called with QoS information about a peer.
651 * @param address the address
652 * @param bandwidth_out assigned outbound bandwidth for the connection
653 * @param bandwidth_in assigned inbound bandwidth for the connection
654 * @param ats performance data for the address (as far as known)
655 * @param ats_count number of performance records in 'ats'
657 typedef void (*GNUNET_ATS_PeerInformationCallback) (void *cls,
659 GNUNET_HELLO_Address *
662 GNUNET_BANDWIDTH_Value32NBO
665 GNUNET_BANDWIDTH_Value32NBO
668 GNUNET_ATS_Information *
669 ats, uint32_t ats_count);
673 * Get handle to access performance API of the ATS subsystem.
675 * @param cfg configuration to use
676 * @param infocb function to call on performance changes, can be NULL
677 * @param infocb_cls closure for infocb
678 * @return ats performance context
680 struct GNUNET_ATS_PerformanceHandle *
681 GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
682 GNUNET_ATS_PeerInformationCallback infocb,
687 * Client is done using the ATS performance subsystem, release resources.
692 GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph);
696 * Function called with reservation result.
699 * @param peer identifies the peer
700 * @param amount set to the amount that was actually reserved or unreserved;
701 * either the full requested amount or zero (no partial reservations)
702 * @param res_delay if the reservation could not be satisfied (amount was 0), how
703 * long should the client wait until re-trying?
705 typedef void (*GNUNET_ATS_ReservationCallback) (void *cls,
706 const struct GNUNET_PeerIdentity
707 * peer, int32_t amount,
708 struct GNUNET_TIME_Relative
714 * Context that can be used to cancel a peer information request.
716 struct GNUNET_ATS_ReservationContext;
720 * Reserve inbound bandwidth from the given peer. ATS will look at
721 * the current amount of traffic we receive from the peer and ensure
722 * that the peer could add 'amount' of data to its stream.
724 * @param ph performance handle
725 * @param peer identifies the peer
726 * @param amount reserve N bytes for receiving, negative
727 * amounts can be used to undo a (recent) reservation;
728 * @param rcb function to call with the resulting reservation information
729 * @param rcb_cls closure for info
730 * @return NULL on error
731 * @deprecated will be replaced soon
733 struct GNUNET_ATS_ReservationContext *
734 GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
735 const struct GNUNET_PeerIdentity *peer,
737 GNUNET_ATS_ReservationCallback rcb,
742 * Cancel request for reserving bandwidth.
744 * @param rc context returned by the original GNUNET_ATS_reserve_bandwidth call
747 GNUNET_ATS_reserve_bandwidth_cancel (struct GNUNET_ATS_ReservationContext *rc);
752 * Enum defining all known preference categories.
754 enum GNUNET_ATS_PreferenceKind
758 * End of preference list.
760 GNUNET_ATS_PREFERENCE_END = 0,
763 * Change the peer's bandwidth value (value per byte of bandwidth in
764 * the goal function) to the given amount. The argument is followed
765 * by a double value giving the desired value (can be negative).
766 * Preference changes are forgotten if peers disconnect.
768 GNUNET_ATS_PREFERENCE_BANDWIDTH,
771 * Change the peer's latency value to the given amount. The
772 * argument is followed by a double value giving the desired value
773 * (can be negative). The absolute score in the goal function is
774 * the inverse of the latency in ms (minimum: 1 ms) multiplied by
775 * the latency preferences.
777 GNUNET_ATS_PREFERENCE_LATENCY
782 * Change preferences for the given peer. Preference changes are forgotten if peers
785 * @param ph performance handle
786 * @param peer identifies the peer
787 * @param ... 0-terminated specification of the desired changes
790 GNUNET_ATS_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
791 const struct GNUNET_PeerIdentity *peer, ...);
796 /* end of file gnunet-service-transport_ats.h */