2 This file is part of GNUnet.
3 (C) 2001 - 2011 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @author Bartlomiej Polot
32 #if 0 /* keep Emacsens' auto-indent happy */
39 #define MESH_DEBUG GNUNET_YES
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_mesh_service.h>
48 /******************************************************************************/
49 /************************** CONSTANTS ******************************/
50 /******************************************************************************/
52 #define GNUNET_MESH_LOCAL_CHANNEL_ID_CLI 0x80000000
53 #define GNUNET_MESH_LOCAL_CHANNEL_ID_SERV 0xB0000000
55 #define HIGH_PID 0xFFFF0000
56 #define LOW_PID 0x0000FFFF
58 #define PID_OVERFLOW(pid, max) (pid > HIGH_PID && max < LOW_PID)
60 /******************************************************************************/
61 /************************** MESSAGES ******************************/
62 /******************************************************************************/
64 GNUNET_NETWORK_STRUCT_BEGIN
67 * Message for a client to register to the service
69 struct GNUNET_MESH_ClientConnect
72 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
74 * Size: sizeof(struct GNUNET_MESH_ClientConnect) +
75 * sizeof(MESH_ApplicationType) * applications +
76 * sizeof(uint16_t) * types
78 struct GNUNET_MessageHeader header;
79 /* uint32_t list_ports[] */
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
89 typedef uint32_t MESH_ChannelNumber;
93 * Hash to be used in Mesh communication. Only 256 bits needed,
94 * instead of the 512 from @c GNUNET_HashCode.
97 struct GNUNET_MeshHash
99 unsigned char bits[256 / 8];
104 * Message for a client to create and destroy channels.
106 struct GNUNET_MESH_ChannelMessage
109 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
111 * Size: sizeof(struct GNUNET_MESH_ChannelMessage)
113 struct GNUNET_MessageHeader header;
116 * ID of a channel controlled by this client.
118 MESH_ChannelNumber channel_id GNUNET_PACKED;
123 struct GNUNET_PeerIdentity peer;
126 * Port of the channel.
128 uint32_t port GNUNET_PACKED;
133 uint32_t opt GNUNET_PACKED;
138 * Message for mesh data traffic.
140 struct GNUNET_MESH_LocalData
143 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA
145 struct GNUNET_MessageHeader header;
150 uint32_t id GNUNET_PACKED;
159 * Message to allow the client send more data to the service
160 * (always service -> client).
162 struct GNUNET_MESH_LocalAck
165 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK
167 struct GNUNET_MessageHeader header;
170 * ID of the channel allowed to send more data.
172 MESH_ChannelNumber channel_id GNUNET_PACKED;
178 * Message to inform the client about channels in the service.
180 struct GNUNET_MESH_LocalInfo
183 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO[_TUNNEL,_PEER]
185 struct GNUNET_MessageHeader header;
188 * ID of the channel allowed to send more data.
190 MESH_ChannelNumber channel_id GNUNET_PACKED;
193 * ID of the owner of the channel (can be local peer).
195 // struct GNUNET_PeerIdentity owner;
198 * ID of the destination of the channel (can be local peer).
200 struct GNUNET_PeerIdentity peer;
205 * Message to inform the client about one of the peers in the service.
207 struct GNUNET_MESH_LocalInfoPeer
210 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_PEER[S]
212 struct GNUNET_MessageHeader header;
217 uint16_t paths GNUNET_PACKED;
220 * Do we have a tunnel toward this peer?
222 int16_t tunnel GNUNET_PACKED;
225 * ID of the destination of the tunnel (can be local peer).
227 struct GNUNET_PeerIdentity destination;
229 /* If type == PEER (no 'S'): GNUNET_PeerIdentity paths[]
230 * (each path ends in destination) */
234 * Message to inform the client about one of the tunnels in the service.
236 struct GNUNET_MESH_LocalInfoTunnel
239 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNEL[S]
241 struct GNUNET_MessageHeader header;
244 * Number of channels.
246 uint32_t channels GNUNET_PACKED;
249 * ID of the destination of the tunnel (can be local peer).
251 struct GNUNET_PeerIdentity destination;
254 * Number of connections.
256 uint32_t connections GNUNET_PACKED;
261 uint16_t estate GNUNET_PACKED;
266 uint16_t cstate GNUNET_PACKED;
268 /* If TUNNEL (no 'S'): GNUNET_PeerIdentity connection_ids[connections] */
269 /* If TUNNEL (no 'S'): uint32_t channel_ids[channels] */
273 GNUNET_NETWORK_STRUCT_END
278 * @brief Translate a fwd variable into a string representation, for logging.
280 * @param fwd Is FWD? (#GNUNET_YES or #GNUNET_NO)
282 * @return String representing FWD or BCK.
289 * Check if one pid is bigger than other, accounting for overflow.
291 * @param bigger Argument that should be bigger.
292 * @param smaller Argument that should be smaller.
294 * @return True if bigger (arg1) has a higher value than smaller (arg 2).
297 GM_is_pid_bigger (uint32_t bigger, uint32_t smaller);
301 * Get the higher ACK value out of two values, taking in account overflow.
303 * @param a First ACK value.
304 * @param b Second ACK value.
306 * @return Highest ACK value from the two.
309 GM_max_pid (uint32_t a, uint32_t b);
313 * Get the lower ACK value out of two values, taking in account overflow.
315 * @param a First ACK value.
316 * @param b Second ACK value.
318 * @return Lowest ACK value from the two.
321 GM_min_pid (uint32_t a, uint32_t b);
325 * Convert a 256 bit MeshHash into a 512 HashCode to use in GNUNET_h2s,
326 * multihashmap, and other HashCode-based functions.
328 * @param id A 256 bit hash to expand.
330 * @return A HashCode containing the original 256 bit hash right-padded with 0.
332 const struct GNUNET_HashCode *
333 GM_h2hc (const struct GNUNET_MeshHash *id);
336 * Convert a message type into a string to help debug
338 * FIND: "#define ([^ ]+)[ ]*([0-9]+)"
339 * REPLACE: " case \2: return "\1"; break;"
341 * @param m Message type.
343 * @return Human readable string description.
348 #if 0 /* keep Emacsens' auto-indent happy */