aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_transport_plugin.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/gnunet_transport_plugin.h')
-rw-r--r--src/include/gnunet_transport_plugin.h335
1 files changed, 0 insertions, 335 deletions
diff --git a/src/include/gnunet_transport_plugin.h b/src/include/gnunet_transport_plugin.h
index d367779e1..31138e8f5 100644
--- a/src/include/gnunet_transport_plugin.h
+++ b/src/include/gnunet_transport_plugin.h
@@ -36,341 +36,6 @@
36#include "gnunet_statistics_service.h" 36#include "gnunet_statistics_service.h"
37#include "gnunet_transport_service.h" 37#include "gnunet_transport_service.h"
38 38
39
40/**
41 * The structs defined here are used by the transport plugin to tell ATS about
42 * the transport's properties like cost and quality and on the other side
43 * the structs are used by highlevel components to communicate the constraints
44 * they have for a transport to ATS
45 *
46 * +---+
47 * +-----------+ Constraints | | Plugin properties +---------+
48 * | Highlevel |------------> |ATS| <------------------|Transport|
49 * | Component | ATS struct | | ATS struct | Plugin |
50 * +-----------+ | | +---------+
51 * +---+
52 *
53 */
54
55#define GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR 0
56
57/**
58 * Enum defining all known property types for ATS
59 * Enum values are used in the GNUNET_TRANSPORT_ATS_Information struct as (key,value)-pair
60 *
61 * Cost are always stored in uint32_t, so all units used to define costs
62 * have to be normalized to fit in uint32_t [0 .. 4.294.967.295]
63 *
64 * To keep the elements ordered
65 * 1..1024 : Values with a relation to cost
66 * 1025..2048 : Values with a relation to quality
67 * 2049..3072 : Values with a relation to availability
68 *
69 */
70enum GNUNET_TRANSPORT_ATS_Property
71{
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: [μs]
257 *
258 * Examples:
259 *
260 * LAN : 180
261 * Dialup: 4000
262 * WLAN : 7000
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: [μs]
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 /* Availability related values */
339 /* =========================== */
340
341 /**
342 * Is a peer reachable?
343 */
344 GNUNET_TRANSPORT_ATS_AVAILABILITY_REACHABLE = 2048,
345
346 /**
347 * Is there a connection established to a peer using this transport
348 */
349 GNUNET_TRANSPORT_ATS_AVAILABILITY_CONNECTED = 2049
350};
351
352/**
353 * This structure will be used by plugins to communicate costs to ATS or by
354 * higher level components to tell ATS their constraints.
355 * Always a pair of (GNUNET_TRANSPORT_ATS_Property, uint32_t value).
356 * Value is always uint32_t, so all units used to define costs have to
357 * be normalized to fit uint32_t.
358 */
359struct GNUNET_TRANSPORT_ATS_Information
360{
361 /**
362 * ATS property type
363 */
364 uint32_t type;
365
366 /**
367 * ATS property value
368 */
369 uint32_t value;
370};
371
372
373
374/** 39/**
375 * Opaque pointer that plugins can use to distinguish specific 40 * Opaque pointer that plugins can use to distinguish specific
376 * connections to a given peer. Typically used by stateful plugins to 41 * connections to a given peer. Typically used by stateful plugins to
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-25 17:04:59 +0000