src/mesh/mesh.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_speed_max                     GNUNET_MESH_TunnelMessage
  67  * tunnel_speed_min                     GNUNET_MESH_TunnelMessage
  68  * tunnel_buffer                        GNUNET_MESH_TunnelMessage
  69  *
  70  * peer_request_connect_add             GNUNET_MESH_PeerControl
  71  * peer_request_connect_del             GNUNET_MESH_PeerControl
  72  * peer_request_connect_by_type         GNUNET_MESH_ConnectPeerByType
  73  * peer_request_connect_by_string       GNUNET_MESH_ConnectPeerByString
  74  *
  75  * peer_blacklist                       GNUNET_MESH_PeerControl
  76  * peer_unblacklist                     GNUNET_MESH_PeerControl
  77  *
  78  * notify_transmit_ready                None (queue / GNUNET_CLIENT_ntf_tmt_rdy)
  79  * notify_transmit_ready_cancel         None (clear of internal data structures)
  80  *
  81  *
  82  * EVENT                                MESSAGE USED
  83  * -----                                ------------
  84  * data                                 GNUNET_MESH_Unicast OR
  85  *                                      GNUNET_MESH_Multicast OR
  86  *                                      GNUNET_MESH_ToOrigin
  87  * data ack                             GNUNET_MESH_LocalAck
  88  *
  89  * new incoming tunnel                  GNUNET_MESH_PeerControl
  90  * peer connects to a tunnel            GNUNET_MESH_PeerControl
  91  * peer disconnects from a tunnel       GNUNET_MESH_PeerControl
  92  */
  93
  94 /******************************************************************************/
  95 /**************************       CONSTANTS      ******************************/
  96 /******************************************************************************/
  97
  98 #define GNUNET_MESH_LOCAL_TUNNEL_ID_CLI         0x80000000
  99 #define GNUNET_MESH_LOCAL_TUNNEL_ID_SERV        0xB0000000
 100
 101 #define HIGH_PID                                0xFFFF0000
 102 #define LOW_PID                                 0x0000FFFF
 103
 104 #define PID_OVERFLOW(pid, max) (pid > HIGH_PID && max < LOW_PID)
 105
 106 /******************************************************************************/
 107 /**************************        MESSAGES      ******************************/
 108 /******************************************************************************/
 109
 110 GNUNET_NETWORK_STRUCT_BEGIN
 111
 112 /**
 113  * Message for a client to register to the service
 114  */
 115 struct GNUNET_MESH_ClientConnect
 116 {
 117     /**
 118      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
 119      *
 120      * Size: sizeof(struct GNUNET_MESH_ClientConnect) +
 121      *       sizeof(MESH_ApplicationType) * applications +
 122      *       sizeof(uint16_t) * types
 123      */
 124   struct GNUNET_MessageHeader header;
 125   uint16_t applications GNUNET_PACKED;
 126   uint16_t types GNUNET_PACKED;
 127   /* uint32_t                 list_apps[applications]     */
 128   /* uint16_t                 list_types[types]           */
 129 };
 130
 131
 132 /**
 133  * Type for tunnel numbering.
 134  * - Local tunnel numbers given by the service (incoming) are >= 0xB0000000
 135  * - Local tunnel numbers given by the client (created) are >= 0x80000000
 136  * - Global tunnel numbers are < 0x80000000
 137  */
 138 typedef uint32_t MESH_TunnelNumber;
 139
 140 /**
 141  * Message for a client to create and destroy tunnels.
 142  */
 143 struct GNUNET_MESH_TunnelMessage
 144 {
 145     /**
 146      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
 147      *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[MAX|MIN]
 148      *
 149      * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
 150      */
 151   struct GNUNET_MessageHeader header;
 152
 153     /**
 154      * ID of a tunnel controlled by this client.
 155      */
 156   MESH_TunnelNumber tunnel_id 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, if any
 179      */
 180   struct GNUNET_PeerIdentity peer;
 181
 182     /**
 183      * Tunnel options (speed, buffering)
 184      */
 185   uint32_t opt;
 186 };
 187
 188 /**
 189  * Message for announce of regular expressions.
 190  */
 191 struct GNUNET_MESH_RegexAnnounce
 192 {
 193     /**
 194      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ANNOUNCE_REGEX
 195      *
 196      * Size: sizeof(struct GNUNET_MESH_RegexAnnounce) + strlen (regex)
 197      */
 198   struct GNUNET_MessageHeader header;
 199
 200     /**
 201      * How many characters do we want to put in an edge label.
 202      */
 203   uint16_t compression_characters;
 204
 205     /**
 206      * Is this the last message for this regex? (for regex > 65k)
 207      */
 208   int16_t last;
 209
 210   /* regex payload  */
 211 };
 212
 213
 214 /**
 215  * Message for:
 216  * - request adding and deleting peers from a tunnel
 217  * - notify the client that peers have connected:
 218  *   -- requested
 219  *   -- unrequested (new incoming tunnels)
 220  * - notify the client that peers have disconnected
 221  */
 222 struct GNUNET_MESH_PeerControl
 223 {
 224
 225     /**
 226      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ADD|DEL|[UN]BLACKLIST]
 227      *       (client to service, client created tunnel)
 228      *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_[CONNECTED|DISCONNECTED]
 229      *       (service to client)
 230      *
 231      * Size: sizeof(struct GNUNET_MESH_PeerControl)
 232      */
 233   struct GNUNET_MessageHeader header;
 234
 235     /**
 236      * ID of a tunnel controlled by this client.
 237      */
 238   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 239
 240     /**
 241      * Peer to connect/disconnect.
 242      */
 243   struct GNUNET_PeerIdentity peer;
 244 };
 245
 246
 247 /**
 248  * Message for connecting to peers offering a service, by service number.
 249  */
 250 struct GNUNET_MESH_ConnectPeerByType
 251 {
 252     /**
 253      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE |
 254      *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_DISCONNECT_PEER_BY_TYPE
 255      *
 256      * Size: sizeof(struct GNUNET_MESH_ConnectPeerByType)
 257      */
 258   struct GNUNET_MessageHeader header;
 259
 260     /**
 261      * ID of a tunnel controlled by this client.
 262      */
 263   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 264
 265     /**
 266      * Type specification
 267      */
 268   GNUNET_MESH_ApplicationType type GNUNET_PACKED;
 269 };
 270
 271
 272 /**
 273  * Message for connecting to peers offering a service, by service string.
 274  */
 275 struct GNUNET_MESH_ConnectPeerByString
 276 {
 277     /**
 278      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING
 279      *
 280      * Size: sizeof(struct GNUNET_MESH_ConnectPeerByString) + strlen (string)
 281      */
 282   struct GNUNET_MessageHeader header;
 283
 284     /**
 285      * ID of a tunnel controlled by this client.
 286      */
 287   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 288
 289   /* String describing the service */
 290 };
 291
 292
 293 /**
 294  * Message to allow the client send more data to the service
 295  * (always service -> client).
 296  */
 297 struct GNUNET_MESH_LocalAck
 298 {
 299     /**
 300      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK
 301      */
 302   struct GNUNET_MessageHeader header;
 303
 304     /**
 305      * ID of the tunnel allowed to send more data.
 306      */
 307   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 308
 309     /**
 310      * ID of the last packet allowed.
 311      */
 312   uint32_t max_pid GNUNET_PACKED;
 313 };
 314
 315
 316 /**
 317  * Message to inform the client about tunnels in the service.
 318  */
 319 struct GNUNET_MESH_LocalMonitor
 320 {
 321   /**
 322      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_MONITOR[_TUNNEL]
 323    */
 324   struct GNUNET_MessageHeader header;
 325
 326   /**
 327    * ID of the tunnel allowed to send more data.
 328    */
 329   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 330
 331   /**
 332    * Number of peers in the tunnel.
 333    */
 334   uint32_t npeers GNUNET_PACKED;
 335
 336   /**
 337    * Alignment.
 338    */
 339   uint32_t reserved GNUNET_PACKED;
 340
 341   /**
 342    * ID of the owner of the tunnel (can be local peer).
 343    */
 344   struct GNUNET_PeerIdentity owner;
 345
 346   /* struct GNUNET_PeerIdentity peers[npeers] */
 347 };
 348
 349
 350 GNUNET_NETWORK_STRUCT_END
 351
 352 /******************************************************************************/
 353 /************************        ENUMERATIONS      ****************************/
 354 /******************************************************************************/
 355
 356 /**
 357  * All the states a peer participating in a tunnel can be in.
 358  */
 359 enum MeshPeerState
 360 {
 361     /**
 362      * Uninitialized status, should never appear in operation.
 363      */
 364   MESH_PEER_INVALID,
 365
 366     /**
 367      * Peer is the root and owner of the tree
 368      */
 369   MESH_PEER_ROOT,
 370
 371     /**
 372      * Peer only retransmits traffic, is not a final destination
 373      */
 374   MESH_PEER_RELAY,
 375
 376     /**
 377      * Path to the peer not known yet
 378      */
 379   MESH_PEER_SEARCHING,
 380
 381     /**
 382      * Request sent, not yet answered.
 383      */
 384   MESH_PEER_WAITING,
 385
 386     /**
 387      * Peer connected and ready to accept data
 388      */
 389   MESH_PEER_READY,
 390
 391     /**
 392      * Peer connected previosly but not responding
 393      */
 394   MESH_PEER_RECONNECTING
 395 };
 396
 397
 398 /**
 399  * Check if one pid is bigger than other, accounting for overflow.
 400  *
 401  * @param bigger Argument that should be bigger.
 402  * @param smaller Argument that should be smaller.
 403  *
 404  * @return True if bigger (arg1) has a higher value than smaller (arg 2).
 405  */
 406 int
 407 GMC_is_pid_bigger (uint32_t bigger, uint32_t smaller);
 408
 409
 410 /**
 411  * Get the higher ACK value out of two values, taking in account overflow.
 412  *
 413  * @param a First ACK value.
 414  * @param b Second ACK value.
 415  *
 416  * @return Highest ACK value from the two.
 417  */
 418 uint32_t
 419 GMC_max_pid (uint32_t a, uint32_t b);
 420
 421
 422 /**
 423  * Get the lower ACK value out of two values, taking in account overflow.
 424  *
 425  * @param a First ACK value.
 426  * @param b Second ACK value.
 427  *
 428  * @return Lowest ACK value from the two.
 429  */
 430 uint32_t
 431 GMC_min_pid (uint32_t a, uint32_t b);
 432
 433
 434 /**
 435  * Convert a message type into a string to help debug
 436  * Generated with:
 437  * FIND:        "#define ([^ ]+)[ ]*([0-9]+)"
 438  * REPLACE:     "    case \2: return "\1"; break;"
 439  *
 440  * @param m Message type.
 441  *
 442  * @return Human readable string description.
 443  */
 444 const char *
 445 GNUNET_MESH_DEBUG_M2S (uint16_t m);
 446
 447 #if 0                           /* keep Emacsens' auto-indent happy */
 448 {
 449 #endif
 450 #ifdef __cplusplus
 451 }
 452 #endif
 453
 454 #endif