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
31 #if 0 /* keep Emacsens' auto-indent happy */
38 #if ! defined(GNUNET_CULL_LOGGING)
39 #define CADET_TIMING_START \
40 struct GNUNET_TIME_Absolute __timestamp; \
41 __timestamp = GNUNET_TIME_absolute_get ()
43 #define CADET_TIMING_END \
44 struct GNUNET_TIME_Relative __duration; \
45 __duration = GNUNET_TIME_absolute_get_duration (__timestamp); \
46 LOG (GNUNET_ERROR_TYPE_INFO, \
47 " %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;
202 * Priority and preferences (an enum GNUNET_MQ_PriorityPreferences)
203 * of the message in NBO.
205 uint32_t pp GNUNET_PACKED;
214 * Message to allow the client send more data to the service
215 * (always service -> client).
217 struct GNUNET_CADET_LocalAck
220 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK
222 struct GNUNET_MessageHeader header;
225 * ID of the channel allowed to send more data.
227 struct GNUNET_CADET_ClientChannelNumber ccn;
232 * Message to inform the client about channels in the service.
234 * TODO: split into two messages!
236 struct GNUNET_CADET_LocalInfo
239 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL or
240 * #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER
242 struct GNUNET_MessageHeader header;
245 * ID of the channel allowed to send more data.
247 struct GNUNET_CADET_ClientChannelNumber ccn;
250 * ID of the destination of the channel (can be local peer).
252 struct GNUNET_PeerIdentity peer;
257 * Message to inform the client about channels in the service.
259 struct GNUNET_CADET_RequestPathInfoMessage
262 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_REQUEST_INFO_PATH
264 struct GNUNET_MessageHeader header;
269 uint32_t resered GNUNET_PACKED;
272 * ID of the destination of the channel (can be local peer).
274 struct GNUNET_PeerIdentity peer;
279 * Message to inform the client about channels in the service.
281 struct GNUNET_CADET_ChannelInfoMessage
284 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL.
286 struct GNUNET_MessageHeader header;
289 * Root of the channel
291 struct GNUNET_PeerIdentity root;
294 * Destination of the channel
296 struct GNUNET_PeerIdentity dest;
303 * Message to as the service about information on a channel.
305 struct GNUNET_CADET_RequestChannelInfoMessage
308 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_REQUEST_INFO_CHANNEL.
310 struct GNUNET_MessageHeader header;
313 * Target of the channel.
315 struct GNUNET_PeerIdentity target;
320 * Message to inform the client about one of the paths known to the service.
322 struct GNUNET_CADET_LocalInfoPath
325 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PATH.
327 struct GNUNET_MessageHeader header;
330 * Offset of the peer that was requested.
332 uint32_t off GNUNET_PACKED;
337 * Message to inform the client about one of the peers in the service.
339 struct GNUNET_CADET_LocalInfoPeers
342 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS
344 struct GNUNET_MessageHeader header;
349 uint16_t paths GNUNET_PACKED;
352 * Do we have a tunnel toward this peer?
354 int16_t tunnel GNUNET_PACKED;
357 * Shortest known path.
359 uint32_t best_path_length GNUNET_PACKED;
362 * ID of the peer (can be local peer).
364 struct GNUNET_PeerIdentity destination;
369 * Message to inform the client about one of the tunnels in the service.
371 * TODO: split into two messages!
373 struct GNUNET_CADET_LocalInfoTunnel
376 * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL
377 * or #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS
379 struct GNUNET_MessageHeader header;
382 * Number of channels.
384 uint32_t channels GNUNET_PACKED;
387 * ID of the destination of the tunnel (can be local peer).
389 struct GNUNET_PeerIdentity destination;
392 * Number of connections.
394 uint32_t connections GNUNET_PACKED;
399 uint16_t estate GNUNET_PACKED;
404 uint16_t cstate GNUNET_PACKED;
406 /* If TUNNEL (no 'S'): struct GNUNET_CADET_ConnectionTunnelIdentifier connection_ids[connections] */
407 /* If TUNNEL (no 'S'): uint32_t channel_ids[channels] */
411 GNUNET_NETWORK_STRUCT_END
415 * @brief Translate a fwd variable into a string representation, for logging.
417 * @param fwd Is FWD? (#GNUNET_YES or #GNUNET_NO)
419 * @return String representing FWD or BCK.
426 * Check if one pid is bigger than other, accounting for overflow.
428 * @param bigger Argument that should be bigger.
429 * @param smaller Argument that should be smaller.
431 * @return True if bigger (arg1) has a higher value than smaller (arg 2).
434 GC_is_pid_bigger (uint32_t bigger, uint32_t smaller);
438 * Get the higher ACK value out of two values, taking in account overflow.
440 * @param a First ACK value.
441 * @param b Second ACK value.
443 * @return Highest ACK value from the two.
446 GC_max_pid (uint32_t a, uint32_t b);
450 * Get the lower ACK value out of two values, taking in account overflow.
452 * @param a First ACK value.
453 * @param b Second ACK value.
455 * @return Lowest ACK value from the two.
458 GC_min_pid (uint32_t a, uint32_t b);
462 * Allocate a string with a hexdump of any binary data.
464 * @param bin Arbitrary binary data.
465 * @param len Length of @a bin in bytes.
466 * @param output Where to write the output (if *output be NULL it's allocated).
468 * @return The size of the output.
471 GC_bin2s (void *bin, unsigned int len, char **output);
475 * Convert a message type into a string to help debug
477 * FIND: "#define ([^ ]+)[ ]*([0-9]+)"
478 * REPLACE: " case \2: return "\1"; break;"
480 * @param m Message type.
482 * @return Human readable string description.
487 #if 0 /* keep Emacsens' auto-indent happy */