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_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 /******************** MESH LOCAL MESSAGES *************************/
51 /******************************************************************************/
52 /* Any API call should be documented in the folowing table under API CALL.
53 * Also, any message type should be documented in the following table, with the
56 * API CALL (GNUNET_MESH_*) MESSAGE USED
57 * ------------------------ ------------
58 * connect GNUNET_MESH_ClientConnect
59 * disconnect None (network level disconnect)
61 * tunnel_create GNUNET_MESH_TunnelMessage
62 * tunnel_destroy GNUNET_MESH_TunnelMessage
63 * tunnel_buffer GNUNET_MESH_TunnelMessage
65 * notify_transmit_ready None (queue / GNUNET_CLIENT_ntf_tmt_rdy)
66 * notify_transmit_ready_cancel None (clear of internal data structures)
71 * data GNUNET_MESH_Unicast OR
72 * GNUNET_MESH_Multicast OR
73 * GNUNET_MESH_ToOrigin
74 * data ack GNUNET_MESH_LocalAck
76 * new incoming tunnel GNUNET_MESH_PeerControl
77 * peer connects to a tunnel FIXME
78 * peer disconnects from a tunnel FIXME
81 /******************************************************************************/
82 /************************** CONSTANTS ******************************/
83 /******************************************************************************/
85 #define GNUNET_MESH_LOCAL_TUNNEL_ID_CLI 0x80000000
86 #define GNUNET_MESH_LOCAL_TUNNEL_ID_SERV 0xB0000000
88 #define HIGH_PID 0xFFFF0000
89 #define LOW_PID 0x0000FFFF
91 #define PID_OVERFLOW(pid, max) (pid > HIGH_PID && max < LOW_PID)
93 /******************************************************************************/
94 /************************** MESSAGES ******************************/
95 /******************************************************************************/
97 GNUNET_NETWORK_STRUCT_BEGIN
100 * Message for a client to register to the service
102 struct GNUNET_MESH_ClientConnect
105 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
107 * Size: sizeof(struct GNUNET_MESH_ClientConnect) +
108 * sizeof(MESH_ApplicationType) * applications +
109 * sizeof(uint16_t) * types
111 struct GNUNET_MessageHeader header;
112 /* uint32_t list_ports[] */
117 * Type for tunnel numbering.
118 * - Local tunnel numbers given by the service (incoming) are >= 0xB0000000
119 * - Local tunnel numbers given by the client (created) are >= 0x80000000
120 * - Global tunnel numbers are < 0x80000000
122 typedef uint32_t MESH_TunnelNumber;
126 * Message for a client to create and destroy tunnels.
128 struct GNUNET_MESH_TunnelMessage
131 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
133 * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
135 struct GNUNET_MessageHeader header;
138 * ID of a tunnel controlled by this client.
140 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
145 struct GNUNET_PeerIdentity peer;
148 * Port of the tunnel.
150 uint32_t port GNUNET_PACKED;
155 uint32_t opt GNUNET_PACKED;
160 * Message for mesh data traffic.
162 struct GNUNET_MESH_LocalData
165 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA
167 struct GNUNET_MessageHeader header;
172 uint32_t tid GNUNET_PACKED;
181 * Message to allow the client send more data to the service
182 * (always service -> client).
184 struct GNUNET_MESH_LocalAck
187 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK
189 struct GNUNET_MessageHeader header;
192 * ID of the tunnel allowed to send more data.
194 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
200 * Message to inform the client about tunnels in the service.
202 struct GNUNET_MESH_LocalMonitor
205 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_MONITOR[_TUNNEL]
207 struct GNUNET_MessageHeader header;
210 * ID of the tunnel allowed to send more data.
212 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
217 uint32_t reserved GNUNET_PACKED;
220 * ID of the owner of the tunnel (can be local peer).
222 struct GNUNET_PeerIdentity owner;
225 * ID of the destination of the tunnel (can be local peer).
227 struct GNUNET_PeerIdentity destination;
231 GNUNET_NETWORK_STRUCT_END
233 /******************************************************************************/
234 /************************ ENUMERATIONS ****************************/
235 /******************************************************************************/
238 * All the states a tunnel can be in.
243 * Uninitialized status, should never appear in operation.
248 * Path to the peer not known yet
250 MESH_TUNNEL_SEARCHING,
253 * Request sent, not yet answered.
258 * Peer connected and ready to accept data
263 * Peer connected previosly but not responding
265 MESH_TUNNEL_RECONNECTING
270 * Check if one pid is bigger than other, accounting for overflow.
272 * @param bigger Argument that should be bigger.
273 * @param smaller Argument that should be smaller.
275 * @return True if bigger (arg1) has a higher value than smaller (arg 2).
278 GMC_is_pid_bigger (uint32_t bigger, uint32_t smaller);
282 * Get the higher ACK value out of two values, taking in account overflow.
284 * @param a First ACK value.
285 * @param b Second ACK value.
287 * @return Highest ACK value from the two.
290 GMC_max_pid (uint32_t a, uint32_t b);
294 * Get the lower ACK value out of two values, taking in account overflow.
296 * @param a First ACK value.
297 * @param b Second ACK value.
299 * @return Lowest ACK value from the two.
302 GMC_min_pid (uint32_t a, uint32_t b);
306 * Convert a message type into a string to help debug
308 * FIND: "#define ([^ ]+)[ ]*([0-9]+)"
309 * REPLACE: " case \2: return "\1"; break;"
311 * @param m Message type.
313 * @return Human readable string description.
316 GNUNET_MESH_DEBUG_M2S (uint16_t m);
318 #if 0 /* keep Emacsens' auto-indent happy */