diff options
Diffstat (limited to 'src/include/gnunet_ats_service.h')
-rw-r--r-- | src/include/gnunet_ats_service.h | 426 |
1 files changed, 418 insertions, 8 deletions
diff --git a/src/include/gnunet_ats_service.h b/src/include/gnunet_ats_service.h index 0213f0ed1..f2d1c2aad 100644 --- a/src/include/gnunet_ats_service.h +++ b/src/include/gnunet_ats_service.h | |||
@@ -22,17 +22,427 @@ | |||
22 | * @brief automatic transport selection and outbound bandwidth determination | 22 | * @brief automatic transport selection and outbound bandwidth determination |
23 | * @author Christian Grothoff | 23 | * @author Christian Grothoff |
24 | * @author Matthias Wachs | 24 | * @author Matthias Wachs |
25 | * | ||
26 | * TODO: | ||
27 | * - move GNUNET_TRANSPORT_ATS* in here and rename... | ||
28 | */ | 25 | */ |
29 | #ifndef GNUNET_ATS_SERVICE_H | 26 | #ifndef GNUNET_ATS_SERVICE_H |
30 | #define GNUNET_ATS_SERVICE_H | 27 | #define GNUNET_ATS_SERVICE_H |
31 | 28 | ||
32 | #include "gnunet_constants.h" | 29 | #include "gnunet_constants.h" |
33 | #include "gnunet_util_lib.h" | 30 | #include "gnunet_util_lib.h" |
34 | #include "gnunet_transport_service.h" | 31 | |
35 | #include "gnunet_transport_plugin.h" | 32 | |
33 | /** | ||
34 | * Enum defining all known property types for ATS Enum values are used | ||
35 | * in the GNUNET_ATS_Information struct as | ||
36 | * (key,value)-pairs. | ||
37 | * | ||
38 | * Cost are always stored in uint32_t, so all units used to define costs | ||
39 | * have to be normalized to fit in uint32_t [0 .. 4.294.967.295] | ||
40 | */ | ||
41 | enum GNUNET_ATS_Property | ||
42 | { | ||
43 | |||
44 | /** | ||
45 | * End of the array. | ||
46 | * @deprecated | ||
47 | */ | ||
48 | GNUNET_ATS_ARRAY_TERMINATOR = 0, | ||
49 | |||
50 | /** | ||
51 | * Actual traffic on this connection from the other peer to this peer. | ||
52 | * | ||
53 | * Unit: [bytes/second] | ||
54 | */ | ||
55 | GNUNET_ATS_UTILIZATION_UP, | ||
56 | |||
57 | /** | ||
58 | * Actual traffic on this connection from this peer to the other peer. | ||
59 | * | ||
60 | * Unit: [bytes/second] | ||
61 | */ | ||
62 | GNUNET_ATS_UTILIZATION_DOWN, | ||
63 | |||
64 | /** | ||
65 | * Delay | ||
66 | * Time between when the time packet is sent and the packet arrives | ||
67 | * | ||
68 | * Unit: [ms] | ||
69 | * | ||
70 | * Examples: | ||
71 | * | ||
72 | * LAN : 1 | ||
73 | * WLAN : 2 | ||
74 | * Dialup: 500 | ||
75 | */ | ||
76 | GNUNET_ATS_QUALITY_NET_DELAY, | ||
77 | |||
78 | /** | ||
79 | * Distance on network layer (required for distance-vector routing). | ||
80 | * | ||
81 | * Unit: [DV-hops] | ||
82 | */ | ||
83 | GNUNET_ATS_QUALITY_NET_DISTANCE, | ||
84 | |||
85 | /** | ||
86 | * Network overhead on WAN (Wide-Area Network) | ||
87 | * | ||
88 | * How many bytes are sent on the WAN when 1 kilobyte (1024 bytes) | ||
89 | * of application data is transmitted? | ||
90 | * A factor used with connect cost, bandwidth cost and energy cost | ||
91 | * to describe the overhead produced by the transport protocol | ||
92 | * | ||
93 | * Unit: [bytes/kb] | ||
94 | * | ||
95 | * Interpretation: less is better | ||
96 | * | ||
97 | * Examples: | ||
98 | * | ||
99 | * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb] | ||
100 | * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb] | ||
101 | * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb] | ||
102 | * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb] | ||
103 | */ | ||
104 | GNUNET_ATS_COST_WAN, | ||
105 | |||
106 | /** | ||
107 | * Network overhead on LAN (Local-Area Network) | ||
108 | * | ||
109 | * How many bytes are sent on the LAN when 1 kilobyte (1024 bytes) | ||
110 | * of application data is transmitted? | ||
111 | * A factor used with connect cost, bandwidth cost and energy cost | ||
112 | * to describe the overhead produced by the transport protocol | ||
113 | * | ||
114 | * Unit: [bytes/kb] | ||
115 | * | ||
116 | * Interpretation: less is better | ||
117 | * | ||
118 | * Examples: | ||
119 | * | ||
120 | * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb] | ||
121 | * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb] | ||
122 | * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb] | ||
123 | * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb] | ||
124 | */ | ||
125 | GNUNET_ATS_COST_LAN, | ||
126 | |||
127 | /** | ||
128 | * Network overhead on WLAN (Wireless Local Area Network) | ||
129 | * | ||
130 | * How many bytes are sent on the LAN when 1 kilobyte (1024 bytes) | ||
131 | * of application data is transmitted? | ||
132 | * A factor used with connect cost, bandwidth cost and energy cost | ||
133 | * to describe the overhead produced by the transport protocol | ||
134 | * | ||
135 | * Unit: [bytes/kb] | ||
136 | * | ||
137 | * Interpretation: less is better | ||
138 | * | ||
139 | * Examples: | ||
140 | * | ||
141 | * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb] | ||
142 | * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb] | ||
143 | * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb] | ||
144 | * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb] | ||
145 | */ | ||
146 | GNUNET_ATS_COST_WLAN | ||
147 | |||
148 | |||
149 | |||
150 | /* Cost related values */ | ||
151 | /* =================== */ | ||
152 | |||
153 | /** | ||
154 | * Volume based cost in financial units to transmit data | ||
155 | * | ||
156 | * Note: This value is not bound to a specific currency or unit and only | ||
157 | * used locally. | ||
158 | * "cent" just refers the smallest amount of money in the respective | ||
159 | * currency. | ||
160 | * | ||
161 | * Unit: [cent/MB] | ||
162 | * | ||
163 | * Interpretation: less is better | ||
164 | * | ||
165 | * Examples: | ||
166 | * LAN: 0 [cent/MB] | ||
167 | * 2G : 10 [cent/MB] | ||
168 | */ | ||
169 | // GNUNET_ATS_COST_FINANCIAL_PER_VOLUME = 1, | ||
170 | |||
171 | /** | ||
172 | * Time based cost in financial units to transmit data | ||
173 | * | ||
174 | * Note: This value is not bound to a specific currency or unit and only | ||
175 | * used locally. | ||
176 | * "cent" just refers the smallest amount of money in the respective | ||
177 | * currency. | ||
178 | * | ||
179 | * Unit: [cent/h] | ||
180 | * | ||
181 | * Interpretation: less is better | ||
182 | * | ||
183 | * Examples: | ||
184 | * LAN : 0 [cent/h] | ||
185 | * Dialup: 10 [cent/h] | ||
186 | */ | ||
187 | // GNUNET_ATS_COST_FINANCIAL_PER_TIME = 2, | ||
188 | |||
189 | /** | ||
190 | * Computational costs | ||
191 | * | ||
192 | * Effort of preparing data to be sent with this transport | ||
193 | * Includes encoding, encryption and conversion of data | ||
194 | * Partial values can be summed up: c_sum = c_enc + c_enc + c_conv | ||
195 | * Resulting values depend on local system properties, e.g. CPU | ||
196 | * | ||
197 | * Unit: [ms/GB] | ||
198 | * | ||
199 | * Interpretation: less is better | ||
200 | * | ||
201 | * Examples: | ||
202 | * | ||
203 | * HTTPS with AES CBC-256: 7,382 | ||
204 | * HTTPS with AES CBC-128: 5,279 | ||
205 | * HTTPS with RC4-1024: 2,652 | ||
206 | */ | ||
207 | // GNUNET_ATS_COST_COMPUTATIONAL = 3, | ||
208 | |||
209 | /** | ||
210 | * Energy consumption | ||
211 | * | ||
212 | * Energy consumption using this transport when sending with a certain | ||
213 | * power at a certain bitrate. This is only an approximation based on: | ||
214 | * Energy consumption E = P / D | ||
215 | * | ||
216 | * with: | ||
217 | * Power P in Watt (J/s) | ||
218 | * Datarate D in MBit/s | ||
219 | * | ||
220 | * Conversion between power P and dBm used by WLAN in radiotap's dBm TX power: | ||
221 | * | ||
222 | * Lp(dbm) = 10 log10 (P/ 1mW) | ||
223 | * | ||
224 | * => P = 1 mW * 10^(Lp(dbm)/10) | ||
225 | * | ||
226 | * Unit: [mJ/MB] | ||
227 | * | ||
228 | * Interpretation: less is better | ||
229 | * | ||
230 | * Examples: | ||
231 | * | ||
232 | * LAN: 0 | ||
233 | * WLAN: 89 (600 mW @ 802.11g /w 54 MBit/s) | ||
234 | * Bluetooth: 267 (100 mW @ BT2.0 EDR /w 3 MBit/s) | ||
235 | */ | ||
236 | // GNUNET_ATS_COST_ENERGY_CONSUMPTION = 4, | ||
237 | |||
238 | /** | ||
239 | * Connect cost | ||
240 | * How many bytes are transmitted to initiate a new connection using | ||
241 | * this transport? | ||
242 | * | ||
243 | * Unit: [bytes] | ||
244 | * | ||
245 | * Interpretation: less is better | ||
246 | * | ||
247 | * Examples: | ||
248 | * | ||
249 | * UDP (No connection) : | ||
250 | * 0 bytes | ||
251 | * TCP (TCP 3-Way handshake): | ||
252 | * 220 bytes Ethernet, 172 bytes TCP/IP, 122 bytes TCP | ||
253 | * HTTP (TCP + Header) : | ||
254 | * 477 bytes Ethernet, 429 bytes TCP/IP, 374 bytes TCP, 278 bytes HTTP | ||
255 | * HTTPS HTTP+TLS Handshake: | ||
256 | * 2129 bytes Ethernet, 1975 bytes TCP/IP, 1755 bytes TCP, 1403 bytes HTTPS | ||
257 | * | ||
258 | * */ | ||
259 | // GNUNET_ATS_COST_CONNECT = 5, | ||
260 | |||
261 | /** | ||
262 | * Bandwidth cost | ||
263 | * | ||
264 | * How many bandwidth is available to consume? | ||
265 | * Used to calculate which impact sending data with this transport has | ||
266 | * | ||
267 | * Unit: [kB/s] | ||
268 | * | ||
269 | * Interpretation: more is better | ||
270 | * | ||
271 | * Examples: | ||
272 | * LAN: 12,800 (100 MBit/s) | ||
273 | * WLAN: 6,912 (54 MBit/s) | ||
274 | * Dial-up: 8 (64 Kbit/s) | ||
275 | * | ||
276 | */ | ||
277 | // GNUNET_ATS_COST_BANDWITH_AVAILABLE = 6, | ||
278 | |||
279 | /** | ||
280 | * Network overhead | ||
281 | * | ||
282 | * How many bytes are sent over the wire when 1 kilobyte (1024 bytes) | ||
283 | * of application data is transmitted? | ||
284 | * A factor used with connect cost, bandwidth cost and energy cost | ||
285 | * to describe the overhead produced by the transport protocol | ||
286 | * | ||
287 | * Unit: [bytes/kb] | ||
288 | * | ||
289 | * Interpretation: less is better | ||
290 | * | ||
291 | * Examples: | ||
292 | * | ||
293 | * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb] | ||
294 | * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb] | ||
295 | * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb] | ||
296 | * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb] | ||
297 | */ | ||
298 | // GNUNET_ATS_COST_NETWORK_OVERHEAD = 7, | ||
299 | |||
300 | |||
301 | /* Quality related values */ | ||
302 | /* ====================== */ | ||
303 | |||
304 | /* Physical layer quality properties */ | ||
305 | |||
306 | /** | ||
307 | * Signal strength on physical layer | ||
308 | * | ||
309 | * Unit: [dBm] | ||
310 | */ | ||
311 | // GNUNET_ATS_QUALITY_PHY_SIGNAL_STRENGTH = 1025, | ||
312 | |||
313 | /** | ||
314 | * Collision rate on physical layer | ||
315 | * | ||
316 | * Unit: [B/s] | ||
317 | */ | ||
318 | // GNUNET_ATS_QUALITY_PHY_COLLISION_RATE = 1026, | ||
319 | |||
320 | /** | ||
321 | * Error rate on physical layer | ||
322 | * | ||
323 | * Unit: [B/s] | ||
324 | */ | ||
325 | // GNUNET_ATS_QUALITY_PHY_ERROR_RATE = 1027, | ||
326 | |||
327 | /** | ||
328 | * Jitter | ||
329 | * Time variations of the delay | ||
330 | * 1st derivative of a delay function | ||
331 | * | ||
332 | * Unit: [ms] | ||
333 | */ | ||
334 | // GNUNET_ATS_QUALITY_NET_JITTER = 1029, | ||
335 | |||
336 | /** | ||
337 | * Error rate on network layer | ||
338 | * | ||
339 | * Unit: [B/s] | ||
340 | * | ||
341 | * Examples: | ||
342 | * | ||
343 | * LAN : 0 | ||
344 | * WLAN : 400 | ||
345 | * Bluetooth : 100 | ||
346 | * Note: This numbers are just assumptions as an example, not | ||
347 | * measured or somehow determined | ||
348 | */ | ||
349 | // GNUNET_ATS_QUALITY_NET_ERRORRATE = 1030, | ||
350 | |||
351 | /** | ||
352 | * Drop rate on network layer | ||
353 | * Bytes actively dismissed by a network component during transmission | ||
354 | * Reasons for dropped data can be full queues, congestion, quota violations... | ||
355 | * | ||
356 | * Unit: [B/s] | ||
357 | * | ||
358 | * Examples: | ||
359 | * | ||
360 | * LAN : 0 | ||
361 | * WLAN : 400 | ||
362 | * Bluetooth : 100 | ||
363 | * Note: This numbers are just assumptions as an example, not | ||
364 | * measured or somehow determined | ||
365 | */ | ||
366 | // GNUNET_ATS_QUALITY_NET_DROPRATE = 1031, | ||
367 | |||
368 | /** | ||
369 | * Loss rate on network layer | ||
370 | * Bytes lost during transmission | ||
371 | * Reasons can be collisions, ... | ||
372 | * | ||
373 | * Unit: [B/s] | ||
374 | * | ||
375 | * Examples: | ||
376 | * | ||
377 | * LAN : 0 | ||
378 | * WLAN : 40 | ||
379 | * Bluetooth : 10 | ||
380 | * Note: This numbers are just assumptions as an example, not measured | ||
381 | * or somehow determined | ||
382 | */ | ||
383 | // GNUNET_ATS_QUALITY_NET_LOSSRATE = 1032, | ||
384 | |||
385 | /** | ||
386 | * Throughput on network layer | ||
387 | * | ||
388 | * Unit: [kB/s] | ||
389 | * | ||
390 | * Examples: | ||
391 | * | ||
392 | * LAN : 3400 | ||
393 | * WLAN : 1200 | ||
394 | * Dialup: 4 | ||
395 | * | ||
396 | */ | ||
397 | // GNUNET_ATS_QUALITY_NET_THROUGHPUT = 1033, | ||
398 | |||
399 | |||
400 | /* Availability related values */ | ||
401 | /* =========================== */ | ||
402 | |||
403 | /** | ||
404 | * Is a peer reachable? | ||
405 | */ | ||
406 | // GNUNET_ATS_AVAILABILITY_REACHABLE = 2048, | ||
407 | |||
408 | /** | ||
409 | * Is there a connection established to a peer using this transport | ||
410 | */ | ||
411 | // GNUNET_ATS_AVAILABILITY_CONNECTED = 2049 | ||
412 | }; | ||
413 | |||
414 | |||
415 | /** | ||
416 | * struct used to communicate the transport's properties like cost and | ||
417 | * quality of service as well as high-level constraints on resource | ||
418 | * consumption. | ||
419 | * | ||
420 | * +---+ | ||
421 | * +-----------+ Constraints | | Plugin properties +---------+ | ||
422 | * | Highlevel |------------> |ATS| <------------------|Transport| | ||
423 | * | Component | ATS struct | | ATS struct | Plugin | | ||
424 | * +-----------+ | | +---------+ | ||
425 | * +---+ | ||
426 | * | ||
427 | * This structure will be used by transport plugins to communicate | ||
428 | * costs to ATS or by higher level components to tell ATS their | ||
429 | * constraints. Always a pair of (GNUNET_ATS_Property, | ||
430 | * uint32_t value). Value is always uint32_t, so all units used to | ||
431 | * define costs have to be normalized to fit uint32_t. | ||
432 | */ | ||
433 | struct GNUNET_ATS_Information | ||
434 | { | ||
435 | /** | ||
436 | * ATS property type, in network byte order. | ||
437 | */ | ||
438 | uint32_t type; | ||
439 | |||
440 | /** | ||
441 | * ATS property value, in network byte order. | ||
442 | */ | ||
443 | uint32_t value; | ||
444 | }; | ||
445 | |||
36 | 446 | ||
37 | 447 | ||
38 | /* ******************************** Scheduling API ***************************** */ | 448 | /* ******************************** Scheduling API ***************************** */ |
@@ -79,7 +489,7 @@ typedef void (*GNUNET_ATS_AddressSuggestionCallback) (void *cls, | |||
79 | GNUNET_BANDWIDTH_Value32NBO | 489 | GNUNET_BANDWIDTH_Value32NBO |
80 | bandwidth_in, | 490 | bandwidth_in, |
81 | const struct | 491 | const struct |
82 | GNUNET_TRANSPORT_ATS_Information | 492 | GNUNET_ATS_Information |
83 | * ats, | 493 | * ats, |
84 | uint32_t ats_count); | 494 | uint32_t ats_count); |
85 | 495 | ||
@@ -142,7 +552,7 @@ GNUNET_ATS_address_update (struct GNUNET_ATS_SchedulingHandle *sh, | |||
142 | const char *plugin_name, | 552 | const char *plugin_name, |
143 | const void *plugin_addr, size_t plugin_addr_len, | 553 | const void *plugin_addr, size_t plugin_addr_len, |
144 | struct Session *session, | 554 | struct Session *session, |
145 | const struct GNUNET_TRANSPORT_ATS_Information *ats, | 555 | const struct GNUNET_ATS_Information *ats, |
146 | uint32_t ats_count); | 556 | uint32_t ats_count); |
147 | 557 | ||
148 | 558 | ||
@@ -200,7 +610,7 @@ typedef void (*GNUNET_ATS_PeerInformationCallback) (void *cls, | |||
200 | GNUNET_BANDWIDTH_Value32NBO | 610 | GNUNET_BANDWIDTH_Value32NBO |
201 | bandwidth_in, | 611 | bandwidth_in, |
202 | const struct | 612 | const struct |
203 | GNUNET_TRANSPORT_ATS_Information | 613 | GNUNET_ATS_Information |
204 | * ats, | 614 | * ats, |
205 | uint32_t ats_count); | 615 | uint32_t ats_count); |
206 | 616 | ||