aboutsummaryrefslogtreecommitdiff
path: root/src/include
diff options
context:
space:
mode:
Diffstat (limited to 'src/include')
-rw-r--r--src/include/gnunet_ats_service.h426
-rw-r--r--src/include/gnunet_core_service.h4
-rw-r--r--src/include/gnunet_mesh_service.h4
-rw-r--r--src/include/gnunet_mesh_service_new.h6
-rw-r--r--src/include/gnunet_transport_plugin.h2
-rw-r--r--src/include/gnunet_transport_service.h355
6 files changed, 430 insertions, 367 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 */
41enum 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 */
433struct 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
diff --git a/src/include/gnunet_core_service.h b/src/include/gnunet_core_service.h
index a7c5ba45c..d0adf127b 100644
--- a/src/include/gnunet_core_service.h
+++ b/src/include/gnunet_core_service.h
@@ -62,7 +62,7 @@ typedef void (*GNUNET_CORE_ConnectEventHandler) (void *cls,
62 const struct 62 const struct
63 GNUNET_PeerIdentity * peer, 63 GNUNET_PeerIdentity * peer,
64 const struct 64 const struct
65 GNUNET_TRANSPORT_ATS_Information 65 GNUNET_ATS_Information
66 * atsi); 66 * atsi);
67 67
68 68
@@ -95,7 +95,7 @@ typedef int (*GNUNET_CORE_MessageCallback) (void *cls,
95 const struct GNUNET_MessageHeader * 95 const struct GNUNET_MessageHeader *
96 message, 96 message,
97 const struct 97 const struct
98 GNUNET_TRANSPORT_ATS_Information * 98 GNUNET_ATS_Information *
99 atsi); 99 atsi);
100 100
101 101
diff --git a/src/include/gnunet_mesh_service.h b/src/include/gnunet_mesh_service.h
index bf43c8289..ab573557c 100644
--- a/src/include/gnunet_mesh_service.h
+++ b/src/include/gnunet_mesh_service.h
@@ -75,7 +75,7 @@ typedef int (*GNUNET_MESH_MessageCallback) (void *cls,
75 const struct GNUNET_MessageHeader * 75 const struct GNUNET_MessageHeader *
76 message, 76 message,
77 const struct 77 const struct
78 GNUNET_TRANSPORT_ATS_Information * 78 GNUNET_ATS_Information *
79 atsi); 79 atsi);
80 80
81 81
@@ -189,7 +189,7 @@ typedef void (*GNUNET_MESH_TunnelConnectHandler) (void *cls,
189 const struct 189 const struct
190 GNUNET_PeerIdentity * peer, 190 GNUNET_PeerIdentity * peer,
191 const struct 191 const struct
192 GNUNET_TRANSPORT_ATS_Information 192 GNUNET_ATS_Information
193 * atsi); 193 * atsi);
194 194
195 195
diff --git a/src/include/gnunet_mesh_service_new.h b/src/include/gnunet_mesh_service_new.h
index 6db406de3..6dd9da66c 100644
--- a/src/include/gnunet_mesh_service_new.h
+++ b/src/include/gnunet_mesh_service_new.h
@@ -75,7 +75,7 @@ typedef int (*GNUNET_MESH_MessageCallback) (void *cls,
75 const struct GNUNET_MessageHeader * 75 const struct GNUNET_MessageHeader *
76 message, 76 message,
77 const struct 77 const struct
78 GNUNET_TRANSPORT_ATS_Information * 78 GNUNET_ATS_Information *
79 atsi); 79 atsi);
80 80
81 81
@@ -124,7 +124,7 @@ typedef void *(GNUNET_MESH_InboundTunnelNotificationHandler) (void *cls,
124 GNUNET_PeerIdentity 124 GNUNET_PeerIdentity
125 * initiator, 125 * initiator,
126 const struct 126 const struct
127 GNUNET_TRANSPORT_ATS_Information 127 GNUNET_ATS_Information
128 * atsi); 128 * atsi);
129 129
130 130
@@ -208,7 +208,7 @@ typedef void (*GNUNET_MESH_PeerConnectHandler) (void *cls,
208 const struct GNUNET_PeerIdentity 208 const struct GNUNET_PeerIdentity
209 * peer, 209 * peer,
210 const struct 210 const struct
211 GNUNET_TRANSPORT_ATS_Information 211 GNUNET_ATS_Information
212 * atsi); 212 * atsi);
213 213
214 214
diff --git a/src/include/gnunet_transport_plugin.h b/src/include/gnunet_transport_plugin.h
index bc5b791d5..9fc0ffd84 100644
--- a/src/include/gnunet_transport_plugin.h
+++ b/src/include/gnunet_transport_plugin.h
@@ -114,7 +114,7 @@ typedef struct
114 GNUNET_MessageHeader 114 GNUNET_MessageHeader
115 * message, 115 * message,
116 const struct 116 const struct
117 GNUNET_TRANSPORT_ATS_Information 117 GNUNET_ATS_Information
118 * ats, 118 * ats,
119 uint32_t 119 uint32_t
120 ats_count, 120 ats_count,
diff --git a/src/include/gnunet_transport_service.h b/src/include/gnunet_transport_service.h
index 2b6675c89..40e3fca5b 100644
--- a/src/include/gnunet_transport_service.h
+++ b/src/include/gnunet_transport_service.h
@@ -35,12 +35,8 @@ extern "C"
35#endif 35#endif
36#endif 36#endif
37 37
38#include "gnunet_bandwidth_lib.h" 38#include "gnunet_util_lib.h"
39#include "gnunet_configuration_lib.h" 39#include "gnunet_ats_service.h"
40#include "gnunet_crypto_lib.h"
41#include "gnunet_connection_lib.h"
42#include "gnunet_scheduler_lib.h"
43#include "gnunet_time_lib.h"
44 40
45/** 41/**
46 * Version number of the transport API. 42 * Version number of the transport API.
@@ -49,349 +45,6 @@ extern "C"
49 45
50 46
51/** 47/**
52 * Enum defining all known property types for ATS Enum values are used
53 * in the GNUNET_TRANSPORT_ATS_Information struct as
54 * (key,value)-pairs.
55 *
56 * Cost are always stored in uint32_t, so all units used to define costs
57 * have to be normalized to fit in uint32_t [0 .. 4.294.967.295]
58 *
59 * To keep the elements ordered
60 * 1..1024 : Values with a relation to cost
61 * 1025..2048 : Values with a relation to quality
62 * 2049..3072 : Values with a relation to availability
63 *
64 */
65enum GNUNET_TRANSPORT_ATS_Property
66{
67
68 /**
69 * End of the array.
70 */
71 GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR = 0,
72
73 /* Cost related values */
74 /* =================== */
75
76 /**
77 * Volume based cost in financial units to transmit data
78 *
79 * Note: This value is not bound to a specific currency or unit and only
80 * used locally.
81 * "cent" just refers the smallest amount of money in the respective
82 * currency.
83 *
84 * Unit: [cent/MB]
85 *
86 * Interpretation: less is better
87 *
88 * Examples:
89 * LAN: 0 [cent/MB]
90 * 2G : 10 [cent/MB]
91 */
92 GNUNET_TRANSPORT_ATS_COST_FINANCIAL_PER_VOLUME = 1,
93
94 /**
95 * Time based cost in financial units to transmit data
96 *
97 * Note: This value is not bound to a specific currency or unit and only
98 * used locally.
99 * "cent" just refers the smallest amount of money in the respective
100 * currency.
101 *
102 * Unit: [cent/h]
103 *
104 * Interpretation: less is better
105 *
106 * Examples:
107 * LAN : 0 [cent/h]
108 * Dialup: 10 [cent/h]
109 */
110 GNUNET_TRANSPORT_ATS_COST_FINANCIAL_PER_TIME = 2,
111
112 /**
113 * Computational costs
114 *
115 * Effort of preparing data to be sent with this transport
116 * Includes encoding, encryption and conversion of data
117 * Partial values can be summed up: c_sum = c_enc + c_enc + c_conv
118 * Resulting values depend on local system properties, e.g. CPU
119 *
120 * Unit: [ms/GB]
121 *
122 * Interpretation: less is better
123 *
124 * Examples:
125 *
126 * HTTPS with AES CBC-256: 7,382
127 * HTTPS with AES CBC-128: 5,279
128 * HTTPS with RC4-1024: 2,652
129 */
130 GNUNET_TRANSPORT_ATS_COST_COMPUTATIONAL = 3,
131
132 /**
133 * Energy consumption
134 *
135 * Energy consumption using this transport when sending with a certain
136 * power at a certain bitrate. This is only an approximation based on:
137 * Energy consumption E = P / D
138 *
139 * with:
140 * Power P in Watt (J/s)
141 * Datarate D in MBit/s
142 *
143 * Conversion between power P and dBm used by WLAN in radiotap's dBm TX power:
144 *
145 * Lp(dbm) = 10 log10 (P/ 1mW)
146 *
147 * => P = 1 mW * 10^(Lp(dbm)/10)
148 *
149 * Unit: [mJ/MB]
150 *
151 * Interpretation: less is better
152 *
153 * Examples:
154 *
155 * LAN: 0
156 * WLAN: 89 (600 mW @ 802.11g /w 54 MBit/s)
157 * Bluetooth: 267 (100 mW @ BT2.0 EDR /w 3 MBit/s)
158 */
159 GNUNET_TRANSPORT_ATS_COST_ENERGY_CONSUMPTION = 4,
160
161 /**
162 * Connect cost
163 * How many bytes are transmitted to initiate a new connection using
164 * this transport?
165 *
166 * Unit: [bytes]
167 *
168 * Interpretation: less is better
169 *
170 * Examples:
171 *
172 * UDP (No connection) :
173 * 0 bytes
174 * TCP (TCP 3-Way handshake):
175 * 220 bytes Ethernet, 172 bytes TCP/IP, 122 bytes TCP
176 * HTTP (TCP + Header) :
177 * 477 bytes Ethernet, 429 bytes TCP/IP, 374 bytes TCP, 278 bytes HTTP
178 * HTTPS HTTP+TLS Handshake:
179 * 2129 bytes Ethernet, 1975 bytes TCP/IP, 1755 bytes TCP, 1403 bytes HTTPS
180 *
181 * */
182 GNUNET_TRANSPORT_ATS_COST_CONNECT = 5,
183
184 /**
185 * Bandwidth cost
186 *
187 * How many bandwidth is available to consume?
188 * Used to calculate which impact sending data with this transport has
189 *
190 * Unit: [kB/s]
191 *
192 * Interpretation: more is better
193 *
194 * Examples:
195 * LAN: 12,800 (100 MBit/s)
196 * WLAN: 6,912 (54 MBit/s)
197 * Dial-up: 8 (64 Kbit/s)
198 *
199 */
200 GNUNET_TRANSPORT_ATS_COST_BANDWITH_AVAILABLE = 6,
201
202 /**
203 * Network overhead
204 *
205 * How many bytes are sent over the wire when 1 kilobyte (1024 bytes)
206 * of application data is transmitted?
207 * A factor used with connect cost, bandwidth cost and energy cost
208 * to describe the overhead produced by the transport protocol
209 *
210 * Unit: [bytes/kb]
211 *
212 * Interpretation: less is better
213 *
214 * Examples:
215 *
216 * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
217 * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
218 * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb]
219 * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb]
220 */
221 GNUNET_TRANSPORT_ATS_COST_NETWORK_OVERHEAD = 7,
222
223
224 /* Quality related values */
225 /* ====================== */
226
227 /* Physical layer quality properties */
228
229 /**
230 * Signal strength on physical layer
231 *
232 * Unit: [dBm]
233 */
234 GNUNET_TRANSPORT_ATS_QUALITY_PHY_SIGNAL_STRENGTH = 1025,
235
236 /**
237 * Collision rate on physical layer
238 *
239 * Unit: [B/s]
240 */
241 GNUNET_TRANSPORT_ATS_QUALITY_PHY_COLLISION_RATE = 1026,
242
243 /**
244 * Error rate on physical layer
245 *
246 * Unit: [B/s]
247 */
248 GNUNET_TRANSPORT_ATS_QUALITY_PHY_ERROR_RATE = 1027,
249
250 /* Network layer quality properties */
251
252 /**
253 * Delay
254 * Time between when the time packet is sent and the packet arrives
255 *
256 * Unit: [ms]
257 *
258 * Examples:
259 *
260 * LAN : 1
261 * WLAN : 2
262 * Dialup: 500
263 */
264 GNUNET_TRANSPORT_ATS_QUALITY_NET_DELAY = 1028,
265
266 /**
267 * Jitter
268 * Time variations of the delay
269 * 1st derivative of a delay function
270 *
271 * Unit: [ms]
272 */
273 GNUNET_TRANSPORT_ATS_QUALITY_NET_JITTER = 1029,
274
275 /**
276 * Error rate on network layer
277 *
278 * Unit: [B/s]
279 *
280 * Examples:
281 *
282 * LAN : 0
283 * WLAN : 400
284 * Bluetooth : 100
285 * Note: This numbers are just assumptions as an example, not
286 * measured or somehow determined
287 */
288 GNUNET_TRANSPORT_ATS_QUALITY_NET_ERRORRATE = 1030,
289
290 /**
291 * Drop rate on network layer
292 * Bytes actively dismissed by a network component during transmission
293 * Reasons for dropped data can be full queues, congestion, quota violations...
294 *
295 * Unit: [B/s]
296 *
297 * Examples:
298 *
299 * LAN : 0
300 * WLAN : 400
301 * Bluetooth : 100
302 * Note: This numbers are just assumptions as an example, not
303 * measured or somehow determined
304 */
305 GNUNET_TRANSPORT_ATS_QUALITY_NET_DROPRATE = 1031,
306
307 /**
308 * Loss rate on network layer
309 * Bytes lost during transmission
310 * Reasons can be collisions, ...
311 *
312 * Unit: [B/s]
313 *
314 * Examples:
315 *
316 * LAN : 0
317 * WLAN : 40
318 * Bluetooth : 10
319 * Note: This numbers are just assumptions as an example, not measured
320 * or somehow determined
321 */
322 GNUNET_TRANSPORT_ATS_QUALITY_NET_LOSSRATE = 1032,
323
324 /**
325 * Throughput on network layer
326 *
327 * Unit: [kB/s]
328 *
329 * Examples:
330 *
331 * LAN : 3400
332 * WLAN : 1200
333 * Dialup: 4
334 *
335 */
336 GNUNET_TRANSPORT_ATS_QUALITY_NET_THROUGHPUT = 1033,
337
338 /**
339 * Distance on network layer
340 *
341 * Unit: []
342 */
343 GNUNET_TRANSPORT_ATS_QUALITY_NET_DISTANCE = 1034,
344
345
346 /* Availability related values */
347 /* =========================== */
348
349 /**
350 * Is a peer reachable?
351 */
352 GNUNET_TRANSPORT_ATS_AVAILABILITY_REACHABLE = 2048,
353
354 /**
355 * Is there a connection established to a peer using this transport
356 */
357 GNUNET_TRANSPORT_ATS_AVAILABILITY_CONNECTED = 2049
358};
359
360
361/**
362 * struct used to communicate the transport's properties like cost and
363 * quality of service as well as high-level constraints on resource
364 * consumption.
365 *
366 * +---+
367 * +-----------+ Constraints | | Plugin properties +---------+
368 * | Highlevel |------------> |ATS| <------------------|Transport|
369 * | Component | ATS struct | | ATS struct | Plugin |
370 * +-----------+ | | +---------+
371 * +---+
372 *
373 * This structure will be used by transport plugins to communicate
374 * costs to ATS or by higher level components to tell ATS their
375 * constraints. Always a pair of (GNUNET_TRANSPORT_ATS_Property,
376 * uint32_t value). Value is always uint32_t, so all units used to
377 * define costs have to be normalized to fit uint32_t.
378 */
379struct GNUNET_TRANSPORT_ATS_Information
380{
381 /**
382 * ATS property type, in network byte order.
383 */
384 uint32_t type;
385
386 /**
387 * ATS property value, in network byte order.
388 */
389 uint32_t value;
390};
391
392
393
394/**
395 * Function called by the transport for each received message. 48 * Function called by the transport for each received message.
396 * 49 *
397 * @param cls closure 50 * @param cls closure
@@ -407,7 +60,7 @@ typedef void (*GNUNET_TRANSPORT_ReceiveCallback) (void *cls,
407 GNUNET_MessageHeader * 60 GNUNET_MessageHeader *
408 message, 61 message,
409 const struct 62 const struct
410 GNUNET_TRANSPORT_ATS_Information 63 GNUNET_ATS_Information
411 * ats, uint32_t ats_count); 64 * ats, uint32_t ats_count);
412 65
413 66
@@ -430,7 +83,7 @@ typedef void (*GNUNET_TRANSPORT_NotifyConnect) (void *cls,
430 const struct GNUNET_PeerIdentity 83 const struct GNUNET_PeerIdentity
431 * peer, 84 * peer,
432 const struct 85 const struct
433 GNUNET_TRANSPORT_ATS_Information 86 GNUNET_ATS_Information
434 * ats, uint32_t ats_count); 87 * ats, uint32_t ats_count);
435 88
436/** 89/**