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 it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
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 0x80000000U
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 channels in the service.
254 struct GNUNET_CADET_RequestPathInfoMessage
257 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_REQUEST_INFO_PATH
259 struct GNUNET_MessageHeader header;
264 uint32_t resered GNUNET_PACKED;
267 * ID of the destination of the channel (can be local peer).
269 struct GNUNET_PeerIdentity peer;
274 * Message to inform the client about channels in the service.
276 struct GNUNET_CADET_ChannelInfoMessage
279 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL.
281 struct GNUNET_MessageHeader header;
284 * Root of the channel
286 struct GNUNET_PeerIdentity root;
289 * Destination of the channel
291 struct GNUNET_PeerIdentity dest;
298 * Message to as the service about information on a channel.
300 struct GNUNET_CADET_RequestChannelInfoMessage
303 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_REQUEST_INFO_CHANNEL.
305 struct GNUNET_MessageHeader header;
308 * Target of the channel.
310 struct GNUNET_PeerIdentity target;
316 * Message to inform the client about one of the paths known to the service.
318 struct GNUNET_CADET_LocalInfoPath
321 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PATH.
323 struct GNUNET_MessageHeader header;
326 * Offset of the peer that was requested.
328 uint32_t off GNUNET_PACKED;
333 * Message to inform the client about one of the peers in the service.
335 struct GNUNET_CADET_LocalInfoPeers
338 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS
340 struct GNUNET_MessageHeader header;
345 uint16_t paths GNUNET_PACKED;
348 * Do we have a tunnel toward this peer?
350 int16_t tunnel GNUNET_PACKED;
353 * Shortest known path.
355 uint32_t best_path_length GNUNET_PACKED;
358 * ID of the peer (can be local peer).
360 struct GNUNET_PeerIdentity destination;
366 * Message to inform the client about one of the tunnels in the service.
368 * TODO: split into two messages!
370 struct GNUNET_CADET_LocalInfoTunnel
373 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL
374 * or #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS
376 struct GNUNET_MessageHeader header;
379 * Number of channels.
381 uint32_t channels GNUNET_PACKED;
384 * ID of the destination of the tunnel (can be local peer).
386 struct GNUNET_PeerIdentity destination;
389 * Number of connections.
391 uint32_t connections GNUNET_PACKED;
396 uint16_t estate GNUNET_PACKED;
401 uint16_t cstate GNUNET_PACKED;
403 /* If TUNNEL (no 'S'): struct GNUNET_CADET_ConnectionTunnelIdentifier connection_ids[connections] */
404 /* If TUNNEL (no 'S'): uint32_t channel_ids[channels] */
408 GNUNET_NETWORK_STRUCT_END
412 * @brief Translate a fwd variable into a string representation, for logging.
414 * @param fwd Is FWD? (#GNUNET_YES or #GNUNET_NO)
416 * @return String representing FWD or BCK.
423 * Check if one pid is bigger than other, accounting for overflow.
425 * @param bigger Argument that should be bigger.
426 * @param smaller Argument that should be smaller.
428 * @return True if bigger (arg1) has a higher value than smaller (arg 2).
431 GC_is_pid_bigger (uint32_t bigger, uint32_t smaller);
435 * Get the higher ACK value out of two values, taking in account overflow.
437 * @param a First ACK value.
438 * @param b Second ACK value.
440 * @return Highest ACK value from the two.
443 GC_max_pid (uint32_t a, uint32_t b);
447 * Get the lower ACK value out of two values, taking in account overflow.
449 * @param a First ACK value.
450 * @param b Second ACK value.
452 * @return Lowest ACK value from the two.
455 GC_min_pid (uint32_t a, uint32_t b);
459 * Allocate a string with a hexdump of any binary data.
461 * @param bin Arbitrary binary data.
462 * @param len Length of @a bin in bytes.
463 * @param output Where to write the output (if *output be NULL it's allocated).
465 * @return The size of the output.
474 * Convert a message type into a string to help debug
476 * FIND: "#define ([^ ]+)[ ]*([0-9]+)"
477 * REPLACE: " case \2: return "\1"; break;"
479 * @param m Message type.
481 * @return Human readable string description.
486 #if 0 /* keep Emacsens' auto-indent happy */