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 the transport's properties like cost and quality
29 * and on the other side the structs are used by highlevel components to communicate the constraints they have for a transprot to ATS
32 * +-----------+ Constraints | | Plugin properties +---------+
33 * | Highlevel |------------> |ATS| <------------------|Transport|
34 * | Component | ATS struct | | ATS struct | Plugin |
35 * +-----------+ | | +---------+
42 * Enum defining all known cost types for ATS
43 * Enum values are used in the GNUNET_ATS_Cost_Information struct as (key,value)-pair
44 * Cost are always stored in uint32_t, so all units used to define costs have to be normalized to fit in uint32_t [0 .. 4.294.967.295]
46 enum GNUNET_ATS_Cost_Type
49 * Cost will be passed as struct GNUNET_ATS_Cost_Information[]
50 * array is 0-terminated:
51 * the last element in the array is the pair (GNUNET_ATS_ARRAY_TERMINATOR, 0)
53 GNUNET_ATS_ARRAY_TERMINATOR= 0,
55 /* Volume based cost in financial units to transmit data
56 * Note: this value is not bound to a specific currency or unit and only used locally
60 * Interpretation: less is better
66 GNUNET_ATS_FINANCIAL_PER_VOLUME_COST = 1,
68 /* Time based cost in financial units to transmit data
69 * Note: this value is not bound to a specific currency or unit
73 * Interpretation: less is better
79 GNUNET_ATS_FINANCIAL_PER_TIME_COST = 2,
81 /* Computational costs
82 * Effort of preparing data to send with this transport
83 * Includes encoding, encryption and conversion of data
84 * Partial values can be summed: c_sum = c_enc + c_conv + c_enc
85 * Resulting value depends on local system properties, e.g. CPU
89 * Interpretation: less is better
93 * HTTPS with AES CBC-256: 7,382
94 * HTTPS with AES CBC-128: 5,279
95 * HTTPS with RC4-1024: 2,652
97 GNUNET_ATS_COMPUTATIONAL_COST = 3,
100 * Energy consumption using this transport when sending with a certain power at a certain bitrate
101 * This is only an approximation based on:
102 * Energy consumption E = P / D
105 * Power P in Watt (J/s)
106 * Datarate D in MBit/s
108 * Conversion between power P and dBm used by WLAN in radiotap's dBm TX power:
110 * Lp(dbm) = 10 log10 (P/ 1mW)
112 * => P = 1 mW * 10^(Lp(dbm)/10)
116 * Interpretation: less is better
121 * WLAN: 89 (600 mW @ 802.11g /w 54 MBit/s)
122 * Bluetooth: 267 (100 mW @ BT2.0 EDR /w 3 MBit/s)
124 GNUNET_ATS_ENERGY_CONSUMPTION = 4,
127 * How expensive is it to initiate a new connection using this transport
131 * Interpretation: less is better
135 * UDP (No connection) : 0 bytes
136 * TCP (TCP 3-Way handshake): 220 bytes Ethernet, 172 bytes TCP/IP, 122 bytes TCP
137 * HTTP (TCP + Header) : 477 bytes Ethernet, 429 bytes TCP/IP, 374 bytes TCP, 278 bytes HTTP
138 * HTTPS HTTP+TLS Handshake: 2129 bytes Ethernet, 1975 bytes TCP/IP, 1755 bytes TCP, 1403 bytes HTTPS
141 GNUNET_ATS_CONNECT_COST = 5,
144 * How many bandwidth is available to consume
145 * Used to calculate which impact sending data with this transport has
149 * Interpretation: more is better
152 * LAN: 12,800 (100 MBit/s)
153 * WLAN: 6,912 (54 MBit/s)
154 * Dial-up: 8 (64 Kbit/s)
157 GNUNET_ATS_BANDWITH_COST = 6,
160 * a factor used with connect cost, bandwidth cost and energy cost to describe the overhead produced by the transport protocol
162 * Unit: [10,000 - (Efficiency in Percent * 100)]
164 * Interpretation: less is better
168 * TCP/IPv4 over Ethernet: 507 (Efficiency: 94,93 %)
169 * TCP/IPv6 over Ethernet: 646 (Efficiency: 93,64 %)
170 * UDP/IPv4 over Ethernet: 429 (Efficiency: 95,71 %)
171 * UDP/IPv6 over Ethernet: 559 (Efficiency: 94,41 %)
173 GNUNET_ATS_NETWORK_OVERHEAD_COST = 7,
177 * This structure will be used by plugins to communicate costs to ATS or by higher level components to tell ATS their constraints
178 * Always a pair of (GNUNET_ATS_Cost_Types, uint32_t value)
179 * Value is always uint32_t, so all units used to define costs have to be normalized to fit uint32_t
181 struct GNUNET_ATS_Cost_Information
195 * Enum defining all known quality types for ATS
196 * Enum values are used in the GNUNET_ATS_Cost_Information struct as (key,value)-pair
197 * Cost are always stored in uint32_t, so all units used to define costs have to be normalized to fit in uint32_t [0 .. 4.294.967.295]
200 enum GNUNET_ATS_Quality_Type
203 * Quality will be passed as struct GNUNET_ATS_Quality_Information[]
204 * array is 0-terminated:
205 * the last element in the array is the pair (GNUNET_ATS_ARRAY_TERMINATOR, 0)
207 GNUNET_ATS_ARRAY_TERMINATOR = 0,
209 /* Physical layer quality properties */
211 GNUNET_ATS_PHY_SIGNAL_STRENGTH = 1,
213 GNUNET_ATS_PHY_COLLISION_RATE = 2,
215 GNUNET_ATS_PHY_ERROR_RATE = 3,
217 /* Network layer quality properties */
219 GNUNET_ATS_NET_DELAY = 4,
221 GNUNET_ATS_NET_LOSSRATE = 5,
223 GNUNET_ATS_NET_ERRORRATE = 6,
225 GNUNET_ATS_NET_DROPRATE = 6,
227 GNUNET_ATS_NET_JITTER = 6,
229 GNUNET_ATS_NET_THROUGHPUT = 7,
233 * This structure will be used by plugins to communicate quality to ATS or by higher level components to tell ATS their
234 * quality constraints
236 * Always a pair of (GNUNET_ATS_Quality_Type, uint32_t value)
237 * Value is always uint32_t, so all units used to define quality values have to be normalized to fit uint32_t
239 struct GNUNET_ATS_Quality_Information
244 uint32_t quality_type;
249 uint32_t quality_value;