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
92 * Value in tunnel info: *int (GNUNET_YES/GNUNET_NO)
97 * Disable buffering on intermediate nodes (for minimum latency).
99 GNUNET_MESH_OPTION_NOBUFFER = 0x1,
102 * Enable tunnel reliability, lost messages will be retransmitted.
104 GNUNET_MESH_OPTION_RELIABLE = 0x2,
107 * Enable out of order delivery of messages.
109 GNUNET_MESH_OPTION_OOORDER = 0x4
113 #define PID_OVERFLOW(pid, max) (pid > HIGH_PID && max < LOW_PID)
115 /******************************************************************************/
116 /************************** MESSAGES ******************************/
117 /******************************************************************************/
119 GNUNET_NETWORK_STRUCT_BEGIN
122 * Message for a client to register to the service
124 struct GNUNET_MESH_ClientConnect
127 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
129 * Size: sizeof(struct GNUNET_MESH_ClientConnect) +
130 * sizeof(MESH_ApplicationType) * applications +
131 * sizeof(uint16_t) * types
133 struct GNUNET_MessageHeader header;
134 /* uint32_t list_ports[] */
139 * Type for tunnel numbering.
140 * - Local tunnel numbers given by the service (incoming) are >= 0xB0000000
141 * - Local tunnel numbers given by the client (created) are >= 0x80000000
142 * - Global tunnel numbers are < 0x80000000
144 typedef uint32_t MESH_TunnelNumber;
148 * Message for a client to create and destroy tunnels.
150 struct GNUNET_MESH_TunnelMessage
153 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
155 * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
157 struct GNUNET_MessageHeader header;
160 * ID of a tunnel controlled by this client.
162 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
167 struct GNUNET_PeerIdentity peer;
170 * Port of the tunnel.
172 uint32_t port GNUNET_PACKED;
177 int32_t options GNUNET_PACKED;
182 * Message for the service to let a client know about created tunnels.
184 struct GNUNET_MESH_TunnelNotification
187 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE
189 * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
191 struct GNUNET_MessageHeader header;
194 * ID of a tunnel controlled by this client.
196 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
199 * Peer at the other end.
201 struct GNUNET_PeerIdentity peer;
204 * Port for this tunnel
206 uint32_t port GNUNET_PACKED;
209 * Tunnel options (speed, buffering)
211 uint32_t opt GNUNET_PACKED;
216 * Message for mesh data traffic.
218 struct GNUNET_MESH_LocalData
221 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA
223 struct GNUNET_MessageHeader header;
228 uint32_t tid GNUNET_PACKED;
237 * Message to allow the client send more data to the service
238 * (always service -> client).
240 struct GNUNET_MESH_LocalAck
243 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK
245 struct GNUNET_MessageHeader header;
248 * ID of the tunnel allowed to send more data.
250 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
256 * Message to inform the client about tunnels in the service.
258 struct GNUNET_MESH_LocalMonitor
261 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_MONITOR[_TUNNEL]
263 struct GNUNET_MessageHeader header;
266 * ID of the tunnel allowed to send more data.
268 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
273 uint32_t reserved GNUNET_PACKED;
276 * ID of the owner of the tunnel (can be local peer).
278 struct GNUNET_PeerIdentity owner;
281 * ID of the destination of the tunnel (can be local peer).
283 struct GNUNET_PeerIdentity destination;
287 GNUNET_NETWORK_STRUCT_END
289 /******************************************************************************/
290 /************************ ENUMERATIONS ****************************/
291 /******************************************************************************/
294 * All the states a tunnel can be in.
299 * Uninitialized status, should never appear in operation.
304 * Path to the peer not known yet
306 MESH_TUNNEL_SEARCHING,
309 * Request sent, not yet answered.
314 * Peer connected and ready to accept data
319 * Peer connected previosly but not responding
321 MESH_TUNNEL_RECONNECTING
326 * Check if one pid is bigger than other, accounting for overflow.
328 * @param bigger Argument that should be bigger.
329 * @param smaller Argument that should be smaller.
331 * @return True if bigger (arg1) has a higher value than smaller (arg 2).
334 GMC_is_pid_bigger (uint32_t bigger, uint32_t smaller);
338 * Get the higher ACK value out of two values, taking in account overflow.
340 * @param a First ACK value.
341 * @param b Second ACK value.
343 * @return Highest ACK value from the two.
346 GMC_max_pid (uint32_t a, uint32_t b);
350 * Get the lower ACK value out of two values, taking in account overflow.
352 * @param a First ACK value.
353 * @param b Second ACK value.
355 * @return Lowest ACK value from the two.
358 GMC_min_pid (uint32_t a, uint32_t b);
362 * Convert a message type into a string to help debug
364 * FIND: "#define ([^ ]+)[ ]*([0-9]+)"
365 * REPLACE: " case \2: return "\1"; break;"
367 * @param m Message type.
369 * @return Human readable string description.
372 GNUNET_MESH_DEBUG_M2S (uint16_t m);
374 #if 0 /* keep Emacsens' auto-indent happy */