src/mesh/mesh2.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001 - 2011 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @author Bartlomiej Polot
  23  * @file mesh/mesh.h
  24  */
  25
  26 #ifndef MESH_H_
  27 #define MESH_H_
  28
  29 #ifdef __cplusplus
  30 extern "C"
  31 {
  32 #if 0                           /* keep Emacsens' auto-indent happy */
  33 }
  34 #endif
  35 #endif
  36
  37 #include <stdint.h>
  38
  39 #define MESH_DEBUG              GNUNET_YES
  40
  41 #define INITIAL_WINDOW_SIZE     8
  42 #define ACK_THRESHOLD           INITIAL_WINDOW_SIZE / 2
  43
  44 #include "platform.h"
  45 #include "gnunet_common.h"
  46 #include "gnunet_util_lib.h"
  47 #include "gnunet_peer_lib.h"
  48 #include "gnunet_core_service.h"
  49 #include "gnunet_protocols.h"
  50 #include <gnunet_mesh_service.h>
  51
  52 /******************************************************************************/
  53 /********************        MESH LOCAL MESSAGES      *************************/
  54 /******************************************************************************/
  55 /*  Any API call should be documented in the folowing table under API CALL.
  56  *  Also, any message type should be documented in the following table, with the
  57  * associated event.
  58  *
  59  * API CALL (GNUNET_MESH_*)             MESSAGE USED
  60  * ------------------------             ------------
  61  * connect                              GNUNET_MESH_ClientConnect
  62  * disconnect                           None (network level disconnect)
  63  *
  64  * tunnel_create                        GNUNET_MESH_TunnelMessage
  65  * tunnel_destroy                       GNUNET_MESH_TunnelMessage
  66  * tunnel_buffer                        GNUNET_MESH_TunnelMessage
  67  *
  68  * notify_transmit_ready                None (queue / GNUNET_CLIENT_ntf_tmt_rdy)
  69  * notify_transmit_ready_cancel         None (clear of internal data structures)
  70  *
  71  *
  72  * EVENT                                MESSAGE USED
  73  * -----                                ------------
  74  * data                                 GNUNET_MESH_Unicast OR
  75  *                                      GNUNET_MESH_Multicast OR
  76  *                                      GNUNET_MESH_ToOrigin
  77  * data ack                             GNUNET_MESH_LocalAck
  78  *
  79  * new incoming tunnel                  GNUNET_MESH_PeerControl
  80  * peer connects to a tunnel            FIXME
  81  * peer disconnects from a tunnel       FIXME
  82  */
  83
  84 /******************************************************************************/
  85 /**************************       CONSTANTS      ******************************/
  86 /******************************************************************************/
  87
  88 #define GNUNET_MESH_LOCAL_TUNNEL_ID_CLI         0x80000000
  89 #define GNUNET_MESH_LOCAL_TUNNEL_ID_SERV        0xB0000000
  90
  91 #define HIGH_PID                                0xFFFF0000
  92 #define LOW_PID                                 0x0000FFFF
  93
  94 #define PID_OVERFLOW(pid, max) (pid > HIGH_PID && max < LOW_PID)
  95
  96 /******************************************************************************/
  97 /**************************        MESSAGES      ******************************/
  98 /******************************************************************************/
  99
 100 GNUNET_NETWORK_STRUCT_BEGIN
 101
 102 /**
 103  * Message for a client to register to the service
 104  */
 105 struct GNUNET_MESH_ClientConnect
 106 {
 107     /**
 108      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
 109      *
 110      * Size: sizeof(struct GNUNET_MESH_ClientConnect) +
 111      *       sizeof(MESH_ApplicationType) * applications +
 112      *       sizeof(uint16_t) * types
 113      */
 114   struct GNUNET_MessageHeader header;
 115   uint16_t types GNUNET_PACKED;
 116   uint16_t ports GNUNET_PACKED;
 117   /* uint16_t                 list_types[types]           */
 118   /* uint32_t                 list_ports[ports]           */
 119 };
 120
 121
 122 /**
 123  * Type for tunnel numbering.
 124  * - Local tunnel numbers given by the service (incoming) are >= 0xB0000000
 125  * - Local tunnel numbers given by the client (created) are >= 0x80000000
 126  * - Global tunnel numbers are < 0x80000000
 127  */
 128 typedef uint32_t MESH_TunnelNumber;
 129
 130
 131 /**
 132  * Message for a client to create and destroy tunnels.
 133  */
 134 struct GNUNET_MESH_TunnelMessage
 135 {
 136     /**
 137      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
 138      *
 139      * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
 140      */
 141   struct GNUNET_MessageHeader header;
 142
 143     /**
 144      * ID of a tunnel controlled by this client.
 145      */
 146   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 147
 148     /**
 149      * Tunnel's peer
 150      */
 151   struct GNUNET_PeerIdentity peer;
 152
 153     /**
 154      * Port of the tunnel.
 155      */
 156   uint32_t port GNUNET_PACKED;
 157 };
 158
 159
 160 /**
 161  * Message for the service to let a client know about created tunnels.
 162  */
 163 struct GNUNET_MESH_TunnelNotification
 164 {
 165     /**
 166      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE
 167      *
 168      * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
 169      */
 170   struct GNUNET_MessageHeader header;
 171
 172     /**
 173      * ID of a tunnel controlled by this client.
 174      */
 175   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 176
 177     /**
 178      * Peer at the other end.
 179      */
 180   struct GNUNET_PeerIdentity peer;
 181
 182     /**
 183      * Port for this tunnel
 184      */
 185   uint32_t port GNUNET_PACKED;
 186
 187     /**
 188      * Tunnel options (speed, buffering)
 189      */
 190   uint32_t opt GNUNET_PACKED;
 191 };
 192
 193
 194 /**
 195  * Message to allow the client send more data to the service
 196  * (always service -> client).
 197  */
 198 struct GNUNET_MESH_LocalAck
 199 {
 200     /**
 201      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK
 202      */
 203   struct GNUNET_MessageHeader header;
 204
 205     /**
 206      * ID of the tunnel allowed to send more data.
 207      */
 208   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 209
 210     /**
 211      * ID of the last packet allowed.
 212      */
 213   uint32_t max_pid GNUNET_PACKED;
 214 };
 215
 216
 217 /**
 218  * Message to inform the client about tunnels in the service.
 219  */
 220 struct GNUNET_MESH_LocalMonitor
 221 {
 222   /**
 223      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_MONITOR[_TUNNEL]
 224    */
 225   struct GNUNET_MessageHeader header;
 226
 227   /**
 228    * ID of the tunnel allowed to send more data.
 229    */
 230   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 231
 232   /**
 233    * Alignment.
 234    */
 235   uint32_t reserved GNUNET_PACKED;
 236
 237   /**
 238    * ID of the owner of the tunnel (can be local peer).
 239    */
 240   struct GNUNET_PeerIdentity owner;
 241
 242   /**
 243    * ID of the destination of the tunnel (can be local peer).
 244    */
 245   struct GNUNET_PeerIdentity destination;
 246 };
 247
 248
 249 GNUNET_NETWORK_STRUCT_END
 250
 251 /******************************************************************************/
 252 /************************        ENUMERATIONS      ****************************/
 253 /******************************************************************************/
 254
 255 /**
 256  * All the states a tunnel can be in.
 257  */
 258 enum MeshTunnelState
 259 {
 260     /**
 261      * Uninitialized status, should never appear in operation.
 262      */
 263   MESH_TUNNEL_NEW,
 264
 265     /**
 266      * Path to the peer not known yet
 267      */
 268   MESH_TUNNEL_SEARCHING,
 269
 270     /**
 271      * Request sent, not yet answered.
 272      */
 273   MESH_TUNNEL_WAITING,
 274
 275     /**
 276      * Peer connected and ready to accept data
 277      */
 278   MESH_TUNNEL_READY,
 279
 280     /**
 281      * Peer connected previosly but not responding
 282      */
 283   MESH_TUNNEL_RECONNECTING
 284 };
 285
 286
 287 /**
 288  * Check if one pid is bigger than other, accounting for overflow.
 289  *
 290  * @param bigger Argument that should be bigger.
 291  * @param smaller Argument that should be smaller.
 292  *
 293  * @return True if bigger (arg1) has a higher value than smaller (arg 2).
 294  */
 295 int
 296 GMC_is_pid_bigger (uint32_t bigger, uint32_t smaller);
 297
 298
 299 /**
 300  * Get the higher ACK value out of two values, taking in account overflow.
 301  *
 302  * @param a First ACK value.
 303  * @param b Second ACK value.
 304  *
 305  * @return Highest ACK value from the two.
 306  */
 307 uint32_t
 308 GMC_max_pid (uint32_t a, uint32_t b);
 309
 310
 311 /**
 312  * Get the lower ACK value out of two values, taking in account overflow.
 313  *
 314  * @param a First ACK value.
 315  * @param b Second ACK value.
 316  *
 317  * @return Lowest ACK value from the two.
 318  */
 319 uint32_t
 320 GMC_min_pid (uint32_t a, uint32_t b);
 321
 322
 323 /**
 324  * Expand a 32 bit value (message type) into a hash for a MultiHashMap (fast).
 325  * WARNING: do not use for anything other than MultiHashMap!
 326  *          does not alter anything other than bits used by idx_of !
 327  *
 328  * @param i 32 bit integer value.
 329  * @param h Hash code to fill.
 330  */
 331 void
 332 GMC_hash32 (uint32_t i, struct GNUNET_HashCode *h);
 333
 334
 335 /**
 336  * Convert a message type into a string to help debug
 337  * Generated with:
 338  * FIND:        "#define ([^ ]+)[ ]*([0-9]+)"
 339  * REPLACE:     "    case \2: return "\1"; break;"
 340  *
 341  * @param m Message type.
 342  *
 343  * @return Human readable string description.
 344  */
 345 const char *
 346 GNUNET_MESH_DEBUG_M2S (uint16_t m);
 347
 348 #if 0                           /* keep Emacsens' auto-indent happy */
 349 {
 350 #endif
 351 #ifdef __cplusplus
 352 }
 353 #endif
 354
 355 #endif