2 This file is part of GNUnet.
3 Copyright (C) 2001 - 2011 GNUnet e.V.
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.
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.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @author Bartlomiej Polot
32 #if 0 /* keep Emacsens' auto-indent happy */
39 #if !defined(GNUNET_CULL_LOGGING)
40 #define CADET_TIMING_START \
41 struct GNUNET_TIME_Absolute __timestamp;\
42 __timestamp = GNUNET_TIME_absolute_get()
44 #define CADET_TIMING_END \
45 struct GNUNET_TIME_Relative __duration;\
46 __duration = GNUNET_TIME_absolute_get_duration (__timestamp);\
47 LOG (GNUNET_ERROR_TYPE_INFO, " %s duration %s\n",\
49 GNUNET_STRINGS_relative_time_to_string (__duration, GNUNET_YES));
51 #define CADET_TIMING_START
52 #define CADET_TIMING_END
57 #include "gnunet_util_lib.h"
58 #include "gnunet_peer_lib.h"
59 #include "gnunet_core_service.h"
60 #include "gnunet_cadet_service.h"
61 #include "gnunet_protocols.h"
62 #include <gnunet_cadet_service.h>
64 /******************************************************************************/
65 /************************** CONSTANTS ******************************/
66 /******************************************************************************/
69 * Minimum value for channel IDs of local clients.
71 #define GNUNET_CADET_LOCAL_CHANNEL_ID_CLI 0x80000000
76 #define HIGH_PID 0xFF000000
81 #define LOW_PID 0x00FFFFFF
85 * Test if the two PIDs (of type `uint32_t`) are in the range where we
86 * have to worry about overflows. This is the case when @a pid is
87 * large and @a max is small, useful when comparing @a pid smaller
90 #define PID_OVERFLOW(pid, max) (((pid) > HIGH_PID) && ((max) < LOW_PID))
92 /******************************************************************************/
93 /************************** MESSAGES ******************************/
94 /******************************************************************************/
96 GNUNET_NETWORK_STRUCT_BEGIN
100 * Number uniquely identifying a channel of a client.
102 struct GNUNET_CADET_ClientChannelNumber
105 * Values for channel numbering.
106 * Local channel numbers given by the service (incoming) are
107 * smaller than #GNUNET_CADET_LOCAL_CHANNEL_ID_CLI.
108 * Local channel numbers given by the client (created) are
109 * larger than #GNUNET_CADET_LOCAL_CHANNEL_ID_CLI.
111 uint32_t channel_of_client GNUNET_PACKED;
116 * Message for a client to create and destroy channels.
118 struct GNUNET_CADET_PortMessage
121 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN
122 * or #GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE
124 * Size: sizeof(struct GNUNET_CADET_ChannelMessage)
126 struct GNUNET_MessageHeader header;
129 * Port to open/close.
131 struct GNUNET_HashCode port GNUNET_PACKED;
136 * Message for a client to create channels.
138 struct GNUNET_CADET_LocalChannelCreateMessage
141 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE
143 * Size: sizeof(struct GNUNET_CADET_ChannelOpenMessageMessage)
145 struct GNUNET_MessageHeader header;
148 * ID of a channel controlled by this client.
150 struct GNUNET_CADET_ClientChannelNumber ccn;
155 struct GNUNET_PeerIdentity peer;
158 * Port of the channel.
160 struct GNUNET_HashCode port;
165 uint32_t opt GNUNET_PACKED;
170 * Message for or to a client to destroy tunnel.
172 struct GNUNET_CADET_LocalChannelDestroyMessage
175 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY
177 struct GNUNET_MessageHeader header;
180 * ID of a channel controlled by this client.
182 struct GNUNET_CADET_ClientChannelNumber ccn;
187 * Message for cadet data traffic.
189 struct GNUNET_CADET_LocalData
192 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA
194 struct GNUNET_MessageHeader header;
199 struct GNUNET_CADET_ClientChannelNumber ccn;
208 * Message to allow the client send more data to the service
209 * (always service -> client).
211 struct GNUNET_CADET_LocalAck
214 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK
216 struct GNUNET_MessageHeader header;
219 * ID of the channel allowed to send more data.
221 struct GNUNET_CADET_ClientChannelNumber ccn;
227 * Message to inform the client about channels in the service.
229 * TODO: split into two messages!
231 struct GNUNET_CADET_LocalInfo
234 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL or
235 * #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER
237 struct GNUNET_MessageHeader header;
240 * ID of the channel allowed to send more data.
242 struct GNUNET_CADET_ClientChannelNumber ccn;
245 * ID of the destination of the channel (can be local peer).
247 struct GNUNET_PeerIdentity peer;
252 * Message to inform the client about one of the peers in the service.
254 * TODO: split into two messages!
256 struct GNUNET_CADET_LocalInfoPeer
259 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER or
260 * #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS
262 struct GNUNET_MessageHeader header;
267 uint16_t paths GNUNET_PACKED;
270 * Do we have a tunnel toward this peer?
272 int16_t tunnel GNUNET_PACKED;
275 * ID of the peer (can be local peer).
277 struct GNUNET_PeerIdentity destination;
279 /* If type == PEER (no 'S'): GNUNET_PeerIdentity paths[]
280 * (each path ends in destination) */
285 * Message to inform the client about one of the tunnels in the service.
287 * TODO: split into two messages!
289 struct GNUNET_CADET_LocalInfoTunnel
292 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL
293 * or #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS
295 struct GNUNET_MessageHeader header;
298 * Number of channels.
300 uint32_t channels GNUNET_PACKED;
303 * ID of the destination of the tunnel (can be local peer).
305 struct GNUNET_PeerIdentity destination;
308 * Number of connections.
310 uint32_t connections GNUNET_PACKED;
315 uint16_t estate GNUNET_PACKED;
320 uint16_t cstate GNUNET_PACKED;
322 /* If TUNNEL (no 'S'): struct GNUNET_CADET_ConnectionTunnelIdentifier connection_ids[connections] */
323 /* If TUNNEL (no 'S'): uint32_t channel_ids[channels] */
327 GNUNET_NETWORK_STRUCT_END
331 * @brief Translate a fwd variable into a string representation, for logging.
333 * @param fwd Is FWD? (#GNUNET_YES or #GNUNET_NO)
335 * @return String representing FWD or BCK.
342 * Check if one pid is bigger than other, accounting for overflow.
344 * @param bigger Argument that should be bigger.
345 * @param smaller Argument that should be smaller.
347 * @return True if bigger (arg1) has a higher value than smaller (arg 2).
350 GC_is_pid_bigger (uint32_t bigger, uint32_t smaller);
354 * Get the higher ACK value out of two values, taking in account overflow.
356 * @param a First ACK value.
357 * @param b Second ACK value.
359 * @return Highest ACK value from the two.
362 GC_max_pid (uint32_t a, uint32_t b);
366 * Get the lower ACK value out of two values, taking in account overflow.
368 * @param a First ACK value.
369 * @param b Second ACK value.
371 * @return Lowest ACK value from the two.
374 GC_min_pid (uint32_t a, uint32_t b);
378 * Allocate a string with a hexdump of any binary data.
380 * @param bin Arbitrary binary data.
381 * @param len Length of @a bin in bytes.
382 * @param output Where to write the output (if *output be NULL it's allocated).
384 * @return The size of the output.
393 * Convert a message type into a string to help debug
395 * FIND: "#define ([^ ]+)[ ]*([0-9]+)"
396 * REPLACE: " case \2: return "\1"; break;"
398 * @param m Message type.
400 * @return Human readable string description.
405 #if 0 /* keep Emacsens' auto-indent happy */