diff options
Diffstat (limited to 'src/include/gnunet_transport_service.h')
-rw-r--r-- | src/include/gnunet_transport_service.h | 355 |
1 files changed, 4 insertions, 351 deletions
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 | */ | ||
65 | enum 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 | */ | ||
379 | struct 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 | /** |