diff options
author | Bart Polot <bart@net.in.tum.de> | 2014-05-07 12:07:16 +0000 |
---|---|---|
committer | Bart Polot <bart@net.in.tum.de> | 2014-05-07 12:07:16 +0000 |
commit | 41716952f1d0508fb621cb5fec31406d3bd96192 (patch) | |
tree | 0ea8e1a1397babe96db05d17cb7618fc69bb88c7 /src/cadet/cadet.h | |
parent | 74794f20cec6fbbd007e0921e7a347655050c024 (diff) | |
download | gnunet-41716952f1d0508fb621cb5fec31406d3bd96192.tar.gz gnunet-41716952f1d0508fb621cb5fec31406d3bd96192.zip |
Renamed directory
Diffstat (limited to 'src/cadet/cadet.h')
-rw-r--r-- | src/cadet/cadet.h | 351 |
1 files changed, 351 insertions, 0 deletions
diff --git a/src/cadet/cadet.h b/src/cadet/cadet.h new file mode 100644 index 000000000..757f8c501 --- /dev/null +++ b/src/cadet/cadet.h | |||
@@ -0,0 +1,351 @@ | |||
1 | /* | ||
2 | This file is part of GNUnet. | ||
3 | (C) 2001 - 2011 Christian Grothoff (and other contributing authors) | ||
4 | |||
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. | ||
9 | |||
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. | ||
14 | |||
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. | ||
19 | */ | ||
20 | |||
21 | /** | ||
22 | * @author Bartlomiej Polot | ||
23 | * @file cadet/cadet.h | ||
24 | */ | ||
25 | |||
26 | #ifndef CADET_H_ | ||
27 | #define CADET_H_ | ||
28 | |||
29 | #ifdef __cplusplus | ||
30 | extern "C" | ||
31 | { | ||
32 | #if 0 /* keep Emacsens' auto-indent happy */ | ||
33 | } | ||
34 | #endif | ||
35 | #endif | ||
36 | |||
37 | #include <stdint.h> | ||
38 | |||
39 | #define CADET_DEBUG GNUNET_YES | ||
40 | |||
41 | #include "platform.h" | ||
42 | #include "gnunet_util_lib.h" | ||
43 | #include "gnunet_peer_lib.h" | ||
44 | #include "gnunet_core_service.h" | ||
45 | #include "gnunet_protocols.h" | ||
46 | #include <gnunet_cadet_service.h> | ||
47 | |||
48 | /******************************************************************************/ | ||
49 | /************************** CONSTANTS ******************************/ | ||
50 | /******************************************************************************/ | ||
51 | |||
52 | #define GNUNET_CADET_LOCAL_CHANNEL_ID_CLI 0x80000000 | ||
53 | #define GNUNET_CADET_LOCAL_CHANNEL_ID_SERV 0xB0000000 | ||
54 | |||
55 | #define HIGH_PID 0xFFFF0000 | ||
56 | #define LOW_PID 0x0000FFFF | ||
57 | |||
58 | #define PID_OVERFLOW(pid, max) (pid > HIGH_PID && max < LOW_PID) | ||
59 | |||
60 | /******************************************************************************/ | ||
61 | /************************** MESSAGES ******************************/ | ||
62 | /******************************************************************************/ | ||
63 | |||
64 | GNUNET_NETWORK_STRUCT_BEGIN | ||
65 | |||
66 | /** | ||
67 | * Message for a client to register to the service | ||
68 | */ | ||
69 | struct GNUNET_CADET_ClientConnect | ||
70 | { | ||
71 | /** | ||
72 | * Type: GNUNET_MESSAGE_TYPE_CADET_LOCAL_CONNECT | ||
73 | * | ||
74 | * Size: sizeof(struct GNUNET_CADET_ClientConnect) + | ||
75 | * sizeof(CADET_ApplicationType) * applications + | ||
76 | * sizeof(uint16_t) * types | ||
77 | */ | ||
78 | struct GNUNET_MessageHeader header; | ||
79 | /* uint32_t list_ports[] */ | ||
80 | }; | ||
81 | |||
82 | |||
83 | /** | ||
84 | * Type for channel numbering. | ||
85 | * - Local channel numbers given by the service (incoming) are >= 0xB0000000 | ||
86 | * - Local channel numbers given by the client (created) are >= 0x80000000 | ||
87 | * - Global channel numbers are < 0x80000000 | ||
88 | */ | ||
89 | typedef uint32_t CADET_ChannelNumber; | ||
90 | |||
91 | |||
92 | /** | ||
93 | * Message for a client to create and destroy channels. | ||
94 | */ | ||
95 | struct GNUNET_CADET_ChannelMessage | ||
96 | { | ||
97 | /** | ||
98 | * Type: GNUNET_MESSAGE_TYPE_CADET_LOCAL_TUNNEL_[CREATE|DESTROY] | ||
99 | * | ||
100 | * Size: sizeof(struct GNUNET_CADET_ChannelMessage) | ||
101 | */ | ||
102 | struct GNUNET_MessageHeader header; | ||
103 | |||
104 | /** | ||
105 | * ID of a channel controlled by this client. | ||
106 | */ | ||
107 | CADET_ChannelNumber channel_id GNUNET_PACKED; | ||
108 | |||
109 | /** | ||
110 | * Channel's peer | ||
111 | */ | ||
112 | struct GNUNET_PeerIdentity peer; | ||
113 | |||
114 | /** | ||
115 | * Port of the channel. | ||
116 | */ | ||
117 | uint32_t port GNUNET_PACKED; | ||
118 | |||
119 | /** | ||
120 | * Options. | ||
121 | */ | ||
122 | uint32_t opt GNUNET_PACKED; | ||
123 | }; | ||
124 | |||
125 | |||
126 | /** | ||
127 | * Message for cadet data traffic. | ||
128 | */ | ||
129 | struct GNUNET_CADET_LocalData | ||
130 | { | ||
131 | /** | ||
132 | * Type: GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA | ||
133 | */ | ||
134 | struct GNUNET_MessageHeader header; | ||
135 | |||
136 | /** | ||
137 | * ID of the channel | ||
138 | */ | ||
139 | uint32_t id GNUNET_PACKED; | ||
140 | |||
141 | /** | ||
142 | * Payload follows | ||
143 | */ | ||
144 | }; | ||
145 | |||
146 | |||
147 | /** | ||
148 | * Message to allow the client send more data to the service | ||
149 | * (always service -> client). | ||
150 | */ | ||
151 | struct GNUNET_CADET_LocalAck | ||
152 | { | ||
153 | /** | ||
154 | * Type: GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK | ||
155 | */ | ||
156 | struct GNUNET_MessageHeader header; | ||
157 | |||
158 | /** | ||
159 | * ID of the channel allowed to send more data. | ||
160 | */ | ||
161 | CADET_ChannelNumber channel_id GNUNET_PACKED; | ||
162 | |||
163 | }; | ||
164 | |||
165 | |||
166 | /** | ||
167 | * Message to inform the client about channels in the service. | ||
168 | */ | ||
169 | struct GNUNET_CADET_LocalInfo | ||
170 | { | ||
171 | /** | ||
172 | * Type: GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO[_TUNNEL,_PEER] | ||
173 | */ | ||
174 | struct GNUNET_MessageHeader header; | ||
175 | |||
176 | /** | ||
177 | * ID of the channel allowed to send more data. | ||
178 | */ | ||
179 | CADET_ChannelNumber channel_id GNUNET_PACKED; | ||
180 | |||
181 | /** | ||
182 | * ID of the owner of the channel (can be local peer). | ||
183 | */ | ||
184 | // struct GNUNET_PeerIdentity owner; | ||
185 | |||
186 | /** | ||
187 | * ID of the destination of the channel (can be local peer). | ||
188 | */ | ||
189 | struct GNUNET_PeerIdentity peer; | ||
190 | }; | ||
191 | |||
192 | |||
193 | /** | ||
194 | * Message to inform the client about one of the peers in the service. | ||
195 | */ | ||
196 | struct GNUNET_CADET_LocalInfoPeer | ||
197 | { | ||
198 | /** | ||
199 | * Type: GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER[S] | ||
200 | */ | ||
201 | struct GNUNET_MessageHeader header; | ||
202 | |||
203 | /** | ||
204 | * Number of paths. | ||
205 | */ | ||
206 | uint16_t paths GNUNET_PACKED; | ||
207 | |||
208 | /** | ||
209 | * Do we have a tunnel toward this peer? | ||
210 | */ | ||
211 | int16_t tunnel GNUNET_PACKED; | ||
212 | |||
213 | /** | ||
214 | * ID of the destination of the tunnel (can be local peer). | ||
215 | */ | ||
216 | struct GNUNET_PeerIdentity destination; | ||
217 | |||
218 | /* If type == PEER (no 'S'): GNUNET_PeerIdentity paths[] | ||
219 | * (each path ends in destination) */ | ||
220 | }; | ||
221 | |||
222 | /** | ||
223 | * Message to inform the client about one of the tunnels in the service. | ||
224 | */ | ||
225 | struct GNUNET_CADET_LocalInfoTunnel | ||
226 | { | ||
227 | /** | ||
228 | * Type: GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL[S] | ||
229 | */ | ||
230 | struct GNUNET_MessageHeader header; | ||
231 | |||
232 | /** | ||
233 | * Number of channels. | ||
234 | */ | ||
235 | uint32_t channels GNUNET_PACKED; | ||
236 | |||
237 | /** | ||
238 | * ID of the destination of the tunnel (can be local peer). | ||
239 | */ | ||
240 | struct GNUNET_PeerIdentity destination; | ||
241 | |||
242 | /** | ||
243 | * Number of connections. | ||
244 | */ | ||
245 | uint32_t connections GNUNET_PACKED; | ||
246 | |||
247 | /** | ||
248 | * Encryption state. | ||
249 | */ | ||
250 | uint16_t estate GNUNET_PACKED; | ||
251 | |||
252 | /** | ||
253 | * Connection state. | ||
254 | */ | ||
255 | uint16_t cstate GNUNET_PACKED; | ||
256 | |||
257 | /* If TUNNEL (no 'S'): GNUNET_PeerIdentity connection_ids[connections] */ | ||
258 | /* If TUNNEL (no 'S'): uint32_t channel_ids[channels] */ | ||
259 | }; | ||
260 | |||
261 | |||
262 | GNUNET_NETWORK_STRUCT_END | ||
263 | |||
264 | |||
265 | |||
266 | /** | ||
267 | * @brief Translate a fwd variable into a string representation, for logging. | ||
268 | * | ||
269 | * @param fwd Is FWD? (#GNUNET_YES or #GNUNET_NO) | ||
270 | * | ||
271 | * @return String representing FWD or BCK. | ||
272 | */ | ||
273 | char * | ||
274 | GM_f2s (int fwd); | ||
275 | |||
276 | |||
277 | /** | ||
278 | * Check if one pid is bigger than other, accounting for overflow. | ||
279 | * | ||
280 | * @param bigger Argument that should be bigger. | ||
281 | * @param smaller Argument that should be smaller. | ||
282 | * | ||
283 | * @return True if bigger (arg1) has a higher value than smaller (arg 2). | ||
284 | */ | ||
285 | int | ||
286 | GM_is_pid_bigger (uint32_t bigger, uint32_t smaller); | ||
287 | |||
288 | |||
289 | /** | ||
290 | * Get the higher ACK value out of two values, taking in account overflow. | ||
291 | * | ||
292 | * @param a First ACK value. | ||
293 | * @param b Second ACK value. | ||
294 | * | ||
295 | * @return Highest ACK value from the two. | ||
296 | */ | ||
297 | uint32_t | ||
298 | GM_max_pid (uint32_t a, uint32_t b); | ||
299 | |||
300 | |||
301 | /** | ||
302 | * Get the lower ACK value out of two values, taking in account overflow. | ||
303 | * | ||
304 | * @param a First ACK value. | ||
305 | * @param b Second ACK value. | ||
306 | * | ||
307 | * @return Lowest ACK value from the two. | ||
308 | */ | ||
309 | uint32_t | ||
310 | GM_min_pid (uint32_t a, uint32_t b); | ||
311 | |||
312 | |||
313 | /** | ||
314 | * Convert a 256 bit CadetHash into a 512 HashCode to use in GNUNET_h2s, | ||
315 | * multihashmap, and other HashCode-based functions. | ||
316 | * | ||
317 | * @param id A 256 bit hash to expand. | ||
318 | * | ||
319 | * @return A HashCode containing the original 256 bit hash right-padded with 0. | ||
320 | */ | ||
321 | const struct GNUNET_HashCode * | ||
322 | GM_h2hc (const struct GNUNET_CADET_Hash *id); | ||
323 | |||
324 | /** | ||
325 | * Get a string from a Cadet Hash (256 bits). | ||
326 | * WARNING: Not reentrant (based on GNUNET_h2s). | ||
327 | */ | ||
328 | const char * | ||
329 | GM_h2s (const struct GNUNET_CADET_Hash *id); | ||
330 | |||
331 | /** | ||
332 | * Convert a message type into a string to help debug | ||
333 | * Generated with: | ||
334 | * FIND: "#define ([^ ]+)[ ]*([0-9]+)" | ||
335 | * REPLACE: " case \2: return "\1"; break;" | ||
336 | * | ||
337 | * @param m Message type. | ||
338 | * | ||
339 | * @return Human readable string description. | ||
340 | */ | ||
341 | const char * | ||
342 | GM_m2s (uint16_t m); | ||
343 | |||
344 | #if 0 /* keep Emacsens' auto-indent happy */ | ||
345 | { | ||
346 | #endif | ||
347 | #ifdef __cplusplus | ||
348 | } | ||
349 | #endif | ||
350 | |||
351 | #endif | ||