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
23 * @file mesh/mesh_enc.h
32 #if 0 /* keep Emacsens' auto-indent happy */
39 #define MESH_DEBUG GNUNET_YES
42 #include "gnunet_common.h"
43 #include "gnunet_util_lib.h"
44 #include "gnunet_peer_lib.h"
45 #include "gnunet_core_service.h"
46 #include "gnunet_protocols.h"
47 #include <gnunet_mesh_service.h>
49 /******************************************************************************/
50 /************************** CONSTANTS ******************************/
51 /******************************************************************************/
53 #define GNUNET_MESH_LOCAL_CHANNEL_ID_CLI 0x80000000
54 #define GNUNET_MESH_LOCAL_CHANNEL_ID_SERV 0xB0000000
56 #define HIGH_PID 0xFFFF0000
57 #define LOW_PID 0x0000FFFF
59 #define PID_OVERFLOW(pid, max) (pid > HIGH_PID && max < LOW_PID)
61 /******************************************************************************/
62 /************************** MESSAGES ******************************/
63 /******************************************************************************/
65 GNUNET_NETWORK_STRUCT_BEGIN
68 * Message for a client to register to the service
70 struct GNUNET_MESH_ClientConnect
73 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
75 * Size: sizeof(struct GNUNET_MESH_ClientConnect) +
76 * sizeof(MESH_ApplicationType) * applications +
77 * sizeof(uint16_t) * types
79 struct GNUNET_MessageHeader header;
80 /* uint32_t list_ports[] */
85 * Type for channel numbering.
86 * - Local channel numbers given by the service (incoming) are >= 0xB0000000
87 * - Local channel numbers given by the client (created) are >= 0x80000000
88 * - Global channel numbers are < 0x80000000
90 typedef uint32_t MESH_ChannelNumber;
94 * Message for a client to create and destroy channels.
96 struct GNUNET_MESH_ChannelMessage
99 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
101 * Size: sizeof(struct GNUNET_MESH_ChannelMessage)
103 struct GNUNET_MessageHeader header;
106 * ID of a channel controlled by this client.
108 MESH_ChannelNumber channel_id GNUNET_PACKED;
113 struct GNUNET_PeerIdentity peer;
116 * Port of the channel.
118 uint32_t port GNUNET_PACKED;
123 uint32_t opt GNUNET_PACKED;
128 * Message for mesh data traffic.
130 struct GNUNET_MESH_LocalData
133 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA
135 struct GNUNET_MessageHeader header;
140 uint32_t id GNUNET_PACKED;
149 * Message to allow the client send more data to the service
150 * (always service -> client).
152 struct GNUNET_MESH_LocalAck
155 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK
157 struct GNUNET_MessageHeader header;
160 * ID of the channel allowed to send more data.
162 MESH_ChannelNumber channel_id GNUNET_PACKED;
168 * Message to inform the client about channels in the service.
170 struct GNUNET_MESH_LocalMonitor
173 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_MONITOR[_TUNNEL]
175 struct GNUNET_MessageHeader header;
178 * ID of the channel allowed to send more data.
180 MESH_ChannelNumber channel_id GNUNET_PACKED;
185 uint32_t reserved GNUNET_PACKED;
188 * ID of the owner of the channel (can be local peer).
190 struct GNUNET_PeerIdentity owner;
193 * ID of the destination of the channel (can be local peer).
195 struct GNUNET_PeerIdentity destination;
199 GNUNET_NETWORK_STRUCT_END
204 * Check if one pid is bigger than other, accounting for overflow.
206 * @param bigger Argument that should be bigger.
207 * @param smaller Argument that should be smaller.
209 * @return True if bigger (arg1) has a higher value than smaller (arg 2).
212 GMC_is_pid_bigger (uint32_t bigger, uint32_t smaller);
216 * Get the higher ACK value out of two values, taking in account overflow.
218 * @param a First ACK value.
219 * @param b Second ACK value.
221 * @return Highest ACK value from the two.
224 GMC_max_pid (uint32_t a, uint32_t b);
228 * Get the lower ACK value out of two values, taking in account overflow.
230 * @param a First ACK value.
231 * @param b Second ACK value.
233 * @return Lowest ACK value from the two.
236 GMC_min_pid (uint32_t a, uint32_t b);
240 * Convert a message type into a string to help debug
242 * FIND: "#define ([^ ]+)[ ]*([0-9]+)"
243 * REPLACE: " case \2: return "\1"; break;"
245 * @param m Message type.
247 * @return Human readable string description.
250 GNUNET_MESH_DEBUG_M2S (uint16_t m);
252 #if 0 /* keep Emacsens' auto-indent happy */