2 This file is part of GNUnet.
3 (C) 2009 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.
22 * @file transport/transport_selection.h
23 * @brief structure definition for automatic transport selection (ATS)
24 * @author Matthias Wachs
28 * The structs defined here are used by the transport plugin to tell ATS about
29 * the transport's properties like cost and quality and on the other side
30 * the structs are used by highlevel components to communicate the constraints
31 * they have for a transport to ATS
34 * +-----------+ Constraints | | Plugin properties +---------+
35 * | Highlevel |------------> |ATS| <------------------|Transport|
36 * | Component | ATS struct | | ATS struct | Plugin |
37 * +-----------+ | | +---------+
42 #define GNUNET_ATS_ARRAY_TERMINATOR 0
45 * Enum defining all known property types for ATS
46 * Enum values are used in the GNUNET_ATS_Information struct as (key,value)-pair
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 * To keep the elements ordered
52 * 1..1024 : Values with a relation to cost
53 * 1025..2048 : Values with a relation to quality
54 * 2049..3072 : Values with a relation to availability
57 enum GNUNET_ATS_Property
60 /* Cost related values */
61 /* =================== */
64 * Volume based cost in financial units to transmit data
66 * Note: This value is not bound to a specific currency or unit and only
68 * "cent" just refers the smallest amount of money in the respective
73 * Interpretation: less is better
79 GNUNET_ATS_COST_FINANCIAL_PER_VOLUME = 1,
82 * Time based cost in financial units to transmit data
84 * Note: This value is not bound to a specific currency or unit and only
86 * "cent" just refers the smallest amount of money in the respective
91 * Interpretation: less is better
97 GNUNET_ATS_COST_FINANCIAL_PER_TIME = 2,
100 * Computational costs
102 * Effort of preparing data to be sent with this transport
103 * Includes encoding, encryption and conversion of data
104 * Partial values can be summed up: c_sum = c_enc + c_enc + c_conv
105 * Resulting values depend on local system properties, e.g. CPU
109 * Interpretation: less is better
113 * HTTPS with AES CBC-256: 7,382
114 * HTTPS with AES CBC-128: 5,279
115 * HTTPS with RC4-1024: 2,652
117 GNUNET_ATS_COST_COMPUTATIONAL = 3,
122 * Energy consumption using this transport when sending with a certain
123 * power at a certain bitrate. This is only an approximation based on:
124 * Energy consumption E = P / D
127 * Power P in Watt (J/s)
128 * Datarate D in MBit/s
130 * Conversion between power P and dBm used by WLAN in radiotap's dBm TX power:
132 * Lp(dbm) = 10 log10 (P/ 1mW)
134 * => P = 1 mW * 10^(Lp(dbm)/10)
138 * Interpretation: less is better
143 * WLAN: 89 (600 mW @ 802.11g /w 54 MBit/s)
144 * Bluetooth: 267 (100 mW @ BT2.0 EDR /w 3 MBit/s)
146 GNUNET_ATS_COST_ENERGY_CONSUMPTION = 4,
150 * How many bytes are transmitted to initiate a new connection using
155 * Interpretation: less is better
159 * UDP (No connection) :
161 * TCP (TCP 3-Way handshake):
162 * 220 bytes Ethernet, 172 bytes TCP/IP, 122 bytes TCP
163 * HTTP (TCP + Header) :
164 * 477 bytes Ethernet, 429 bytes TCP/IP, 374 bytes TCP, 278 bytes HTTP
165 * HTTPS HTTP+TLS Handshake:
166 * 2129 bytes Ethernet, 1975 bytes TCP/IP, 1755 bytes TCP, 1403 bytes HTTPS
169 GNUNET_ATS_COST_CONNECT = 5,
174 * How many bandwidth is available to consume?
175 * Used to calculate which impact sending data with this transport has
179 * Interpretation: more is better
182 * LAN: 12,800 (100 MBit/s)
183 * WLAN: 6,912 (54 MBit/s)
184 * Dial-up: 8 (64 Kbit/s)
187 GNUNET_ATS_COST_BANDWITH_AVAILABLE = 6,
192 * How many bytes are sent over the wire when 1 kilobyte (1024 bytes)
193 * of application data is transmitted?
194 * A factor used with connect cost, bandwidth cost and energy cost
195 * to describe the overhead produced by the transport protocol
199 * Interpretation: less is better
203 * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
204 * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
205 * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb]
206 * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb]
208 GNUNET_ATS_COST_NETWORK_OVERHEAD = 7,
211 /* Quality related values */
212 /* ====================== */
214 /* Physical layer quality properties */
217 * Signal strength on physical layer
221 GNUNET_ATS_QUALITY_PHY_SIGNAL_STRENGTH = 1025,
224 * Collision rate on physical layer
228 GNUNET_ATS_QUALITY_PHY_COLLISION_RATE = 1026,
231 * Error rate on physical layer
235 GNUNET_ATS_QUALITY_PHY_ERROR_RATE = 1027,
237 /* Network layer quality properties */
241 * Time between when the time packet is sent and the packet arrives
251 GNUNET_ATS_QUALITY_NET_DELAY = 1028,
255 * Time variations of the delay
256 * 1st derivative of a delay function
260 GNUNET_ATS_QUALITY_NET_JITTER = 1029,
263 * Error rate on network layer
272 * Note: This numbers are just assumptions as an example, not
273 * measured or somehow determined
275 GNUNET_ATS_QUALITY_NET_ERRORRATE = 1030,
278 * Drop rate on network layer
279 * Bytes actively dismissed by a network component during transmission
280 * Reasons for dropped data can be full queues, congestion, quota violations...
289 * Note: This numbers are just assumptions as an example, not
290 * measured or somehow determined
292 GNUNET_ATS_QUALITY_NET_DROPRATE = 1031,
295 * Loss rate on network layer
296 * Bytes lost during transmission
297 * Reasons can be collisions, ...
306 * Note: This numbers are just assumptions as an example, not measured
307 * or somehow determined
309 GNUNET_ATS_QUALITY_NET_LOSSRATE = 1032,
312 * Throughput on network layer
323 GNUNET_ATS_QUALITY_NET_THROUGHPUT = 1033,
325 /* Availability related values */
326 /* =========================== */
329 * Is a peer reachable?
331 GNUNET_ATS_AVAILABILITY_REACHABLE = 2048,
334 * Is there a connection established to a peer using this transport
336 GNUNET_ATS_AVAILABILITY_CONNECTED = 2049
340 * This structure will be used by plugins to communicate costs to ATS or by
341 * higher level components to tell ATS their constraints.
342 * Always a pair of (GNUNET_ATS_Property, uint32_t value).
343 * Value is always uint32_t, so all units used to define costs have to
344 * be normalized to fit uint32_t.
346 struct GNUNET_ATS_Information
359 /* end of transport_selection.h */