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 #include "platform.h"
  42 #include "gnunet_util_lib.h"
  43 #include "gnunet_peer_lib.h"
  44 #include "gnunet_core_service.h"
  45 #include "gnunet_protocols.h"
  46 #include <gnunet_mesh_service.h>
  47
  48 /******************************************************************************/
  49 /**************************       CONSTANTS      ******************************/
  50 /******************************************************************************/
  51
  52 #define GNUNET_MESH_LOCAL_CHANNEL_ID_CLI        0x80000000
  53 #define GNUNET_MESH_LOCAL_CHANNEL_ID_SERV       0xB0000000
  54
  55 #define HIGH_PID                                0xFFFF0000
  56 #define LOW_PID                                 0x0000FFFF
  57
  58 #define PID_OVERFLOW(pid, max) (pid > HIGH_PID && max < LOW_PID)
  59
  60 /******************************************************************************/
  61 /**************************        MESSAGES      ******************************/
  62 /******************************************************************************/
  63
  64 GNUNET_NETWORK_STRUCT_BEGIN
  65
  66 /**
  67  * Message for a client to register to the service
  68  */
  69 struct GNUNET_MESH_ClientConnect
  70 {
  71     /**
  72      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
  73      *
  74      * Size: sizeof(struct GNUNET_MESH_ClientConnect) +
  75      *       sizeof(MESH_ApplicationType) * applications +
  76      *       sizeof(uint16_t) * types
  77      */
  78   struct GNUNET_MessageHeader header;
  79   /* uint32_t                 list_ports[]           */
  80 };
  81
  82
  83 /**
  84  * Type for channel numbering.
  85  * - Local channel numbers given by the service (incoming) are >= 0xB0000000
  86  * - Local channel numbers given by the client (created) are >= 0x80000000
  87  * - Global channel numbers are < 0x80000000
  88  */
  89 typedef uint32_t MESH_ChannelNumber;
  90
  91
  92 /**
  93  * Message for a client to create and destroy channels.
  94  */
  95 struct GNUNET_MESH_ChannelMessage
  96 {
  97     /**
  98      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
  99      *
 100      * Size: sizeof(struct GNUNET_MESH_ChannelMessage)
 101      */
 102   struct GNUNET_MessageHeader header;
 103
 104     /**
 105      * ID of a channel controlled by this client.
 106      */
 107   MESH_ChannelNumber channel_id GNUNET_PACKED;
 108
 109     /**
 110      * Channel's peer
 111      */
 112   struct GNUNET_PeerIdentity peer;
 113
 114     /**
 115      * Port of the channel.
 116      */
 117   uint32_t port GNUNET_PACKED;
 118
 119     /**
 120      * Options.
 121      */
 122   uint32_t opt GNUNET_PACKED;
 123 };
 124
 125
 126 /**
 127  * Message for mesh data traffic.
 128  */
 129 struct GNUNET_MESH_LocalData
 130 {
 131     /**
 132      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA
 133      */
 134   struct GNUNET_MessageHeader header;
 135
 136     /**
 137      * ID of the channel
 138      */
 139   uint32_t id GNUNET_PACKED;
 140
 141     /**
 142      * Payload follows
 143      */
 144 };
 145
 146
 147 /**
 148  * Message to allow the client send more data to the service
 149  * (always service -> client).
 150  */
 151 struct GNUNET_MESH_LocalAck
 152 {
 153     /**
 154      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK
 155      */
 156   struct GNUNET_MessageHeader header;
 157
 158     /**
 159      * ID of the channel allowed to send more data.
 160      */
 161   MESH_ChannelNumber channel_id GNUNET_PACKED;
 162
 163 };
 164
 165
 166 /**
 167  * Message to inform the client about channels in the service.
 168  */
 169 struct GNUNET_MESH_LocalMonitor
 170 {
 171   /**
 172      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_MONITOR[_TUNNEL]
 173    */
 174   struct GNUNET_MessageHeader header;
 175
 176   /**
 177    * ID of the channel allowed to send more data.
 178    */
 179   MESH_ChannelNumber channel_id GNUNET_PACKED;
 180
 181   /**
 182    * Alignment.
 183    */
 184   uint32_t reserved GNUNET_PACKED;
 185
 186   /**
 187    * ID of the owner of the channel (can be local peer).
 188    */
 189   struct GNUNET_PeerIdentity owner;
 190
 191   /**
 192    * ID of the destination of the channel (can be local peer).
 193    */
 194   struct GNUNET_PeerIdentity destination;
 195 };
 196
 197
 198 GNUNET_NETWORK_STRUCT_END
 199
 200
 201
 202 /**
 203  * @brief Translate a fwd variable into a string representation, for logging.
 204  *
 205  * @param fwd Is FWD? (#GNUNET_YES or #GNUNET_NO)
 206  *
 207  * @return String representing FWD or BCK.
 208  */
 209 char *
 210 GM_f2s (int fwd);
 211
 212
 213 /**
 214  * Check if one pid is bigger than other, accounting for overflow.
 215  *
 216  * @param bigger Argument that should be bigger.
 217  * @param smaller Argument that should be smaller.
 218  *
 219  * @return True if bigger (arg1) has a higher value than smaller (arg 2).
 220  */
 221 int
 222 GM_is_pid_bigger (uint32_t bigger, uint32_t smaller);
 223
 224
 225 /**
 226  * Get the higher ACK value out of two values, taking in account overflow.
 227  *
 228  * @param a First ACK value.
 229  * @param b Second ACK value.
 230  *
 231  * @return Highest ACK value from the two.
 232  */
 233 uint32_t
 234 GM_max_pid (uint32_t a, uint32_t b);
 235
 236
 237 /**
 238  * Get the lower ACK value out of two values, taking in account overflow.
 239  *
 240  * @param a First ACK value.
 241  * @param b Second ACK value.
 242  *
 243  * @return Lowest ACK value from the two.
 244  */
 245 uint32_t
 246 GM_min_pid (uint32_t a, uint32_t b);
 247
 248
 249 /**
 250  * Convert a message type into a string to help debug
 251  * Generated with:
 252  * FIND:        "#define ([^ ]+)[ ]*([0-9]+)"
 253  * REPLACE:     "    case \2: return "\1"; break;"
 254  *
 255  * @param m Message type.
 256  *
 257  * @return Human readable string description.
 258  */
 259 const char *
 260 GM_m2s (uint16_t m);
 261
 262 #if 0                           /* keep Emacsens' auto-indent happy */
 263 {
 264 #endif
 265 #ifdef __cplusplus
 266 }
 267 #endif
 268
 269 #endif