src/cadet/cadet.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2001 - 2011 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @author Bartlomiej Polot
  23  * @file cadet/cadet.h
  24  */
  25
  26 #ifndef CADET_H_
  27 #define CADET_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 #if !defined(GNUNET_CULL_LOGGING)
  40   #define CADET_TIMING_START \
  41           struct GNUNET_TIME_Absolute __timestamp;\
  42           __timestamp = GNUNET_TIME_absolute_get()
  43
  44   #define CADET_TIMING_END   \
  45           struct GNUNET_TIME_Relative __duration;\
  46           __duration = GNUNET_TIME_absolute_get_duration (__timestamp);\
  47           LOG (GNUNET_ERROR_TYPE_INFO, " %s duration %s\n",\
  48               __FUNCTION__,\
  49               GNUNET_STRINGS_relative_time_to_string (__duration, GNUNET_YES));
  50 #else
  51   #define CADET_TIMING_START
  52   #define CADET_TIMING_END
  53 #endif
  54
  55
  56 #include "platform.h"
  57 #include "gnunet_util_lib.h"
  58 #include "gnunet_peer_lib.h"
  59 #include "gnunet_core_service.h"
  60 #include "gnunet_cadet_service.h"
  61 #include "gnunet_protocols.h"
  62 #include <gnunet_cadet_service.h>
  63
  64 /******************************************************************************/
  65 /**************************       CONSTANTS      ******************************/
  66 /******************************************************************************/
  67
  68 /**
  69  * Minimum value for channel IDs of local clients.
  70  */
  71 #define GNUNET_CADET_LOCAL_CHANNEL_ID_CLI        0x80000000
  72
  73 /**
  74  * FIXME.
  75  */
  76 #define HIGH_PID                                0xFF000000
  77
  78 /**
  79  * FIXME.
  80  */
  81 #define LOW_PID                                 0x00FFFFFF
  82
  83
  84 /**
  85  * Test if the two PIDs (of type `uint32_t`) are in the range where we
  86  * have to worry about overflows.  This is the case when @a pid is
  87  * large and @a max is small, useful when comparing @a pid smaller
  88  * than @a max.
  89  */
  90 #define PID_OVERFLOW(pid, max) (((pid) > HIGH_PID) && ((max) < LOW_PID))
  91
  92 /******************************************************************************/
  93 /**************************        MESSAGES      ******************************/
  94 /******************************************************************************/
  95
  96 GNUNET_NETWORK_STRUCT_BEGIN
  97
  98
  99 /**
 100  * Number uniquely identifying a channel of a client.
 101  */
 102 struct GNUNET_CADET_ClientChannelNumber
 103 {
 104   /**
 105    * Values for channel numbering.
 106    * Local channel numbers given by the service (incoming) are
 107    * smaller than #GNUNET_CADET_LOCAL_CHANNEL_ID_CLI.
 108    * Local channel numbers given by the client (created) are
 109    * larger than #GNUNET_CADET_LOCAL_CHANNEL_ID_CLI.
 110    */
 111   uint32_t channel_of_client GNUNET_PACKED;
 112 };
 113
 114
 115 /**
 116  * Message for a client to create and destroy channels.
 117  */
 118 struct GNUNET_CADET_PortMessage
 119 {
 120   /**
 121    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN
 122    * or #GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE
 123    *
 124    * Size: sizeof(struct GNUNET_CADET_ChannelMessage)
 125    */
 126   struct GNUNET_MessageHeader header;
 127
 128   /**
 129    * Port to open/close.
 130    */
 131   struct GNUNET_HashCode port GNUNET_PACKED;
 132 };
 133
 134
 135 /**
 136  * Message for a client to create channels.
 137  */
 138 struct GNUNET_CADET_ChannelCreateMessageMessage
 139 {
 140   /**
 141    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_TUNNEL_CREATE
 142    *
 143    * Size: sizeof(struct GNUNET_CADET_ChannelCreateMessageMessage)
 144    */
 145   struct GNUNET_MessageHeader header;
 146
 147   /**
 148    * ID of a channel controlled by this client.
 149    */
 150   struct GNUNET_CADET_ClientChannelNumber channel_id;
 151
 152   /**
 153    * Channel's peer
 154    */
 155   struct GNUNET_PeerIdentity peer;
 156
 157   /**
 158    * Port of the channel.
 159    */
 160   struct GNUNET_HashCode port;
 161
 162   /**
 163    * Options.
 164    */
 165   uint32_t opt GNUNET_PACKED;
 166 };
 167
 168
 169 /**
 170  * Message for a client to destroy channels.
 171  */
 172 struct GNUNET_CADET_ChannelDestroyMessage
 173 {
 174   /**
 175    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_TUNNEL_DESTROY
 176    *
 177    * Size: sizeof(struct GNUNET_CADET_ChannelDestroyMessage)
 178    */
 179   struct GNUNET_MessageHeader header;
 180
 181   /**
 182    * ID of a channel controlled by this client.
 183    */
 184   struct GNUNET_CADET_ClientChannelNumber channel_id;
 185 };
 186
 187
 188 /**
 189  * Message for cadet data traffic.
 190  */
 191 struct GNUNET_CADET_LocalData
 192 {
 193   /**
 194    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA
 195    */
 196   struct GNUNET_MessageHeader header;
 197
 198   /**
 199    * ID of the channel
 200    */
 201   struct GNUNET_CADET_ClientChannelNumber id;
 202
 203   /**
 204    * Payload follows
 205    */
 206 };
 207
 208
 209 /**
 210  * Message to allow the client send more data to the service
 211  * (always service -> client).
 212  */
 213 struct GNUNET_CADET_LocalAck
 214 {
 215   /**
 216    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK
 217    */
 218   struct GNUNET_MessageHeader header;
 219
 220   /**
 221    * ID of the channel allowed to send more data.
 222    */
 223   struct GNUNET_CADET_ClientChannelNumber channel_id;
 224
 225 };
 226
 227
 228 /**
 229  * Message to inform the client about channels in the service.
 230  */
 231 struct GNUNET_CADET_LocalInfo
 232 {
 233   /**
 234    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL or
 235    * #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER
 236    */
 237   struct GNUNET_MessageHeader header;
 238
 239   /**
 240    * ID of the channel allowed to send more data.
 241    */
 242   struct GNUNET_CADET_ClientChannelNumber channel_id;
 243
 244   /**
 245    * ID of the owner of the channel (can be local peer).
 246    */
 247 //   struct GNUNET_PeerIdentity owner;
 248
 249   /**
 250    * ID of the destination of the channel (can be local peer).
 251    */
 252   struct GNUNET_PeerIdentity peer;
 253 };
 254
 255
 256 /**
 257  * Message to inform the client about one of the peers in the service.
 258  */
 259 struct GNUNET_CADET_LocalInfoPeer
 260 {
 261   /**
 262    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER or
 263    * #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS
 264    */
 265   struct GNUNET_MessageHeader header;
 266
 267   /**
 268    * Number of paths.
 269    */
 270   uint16_t paths GNUNET_PACKED;
 271
 272   /**
 273    * Do we have a tunnel toward this peer?
 274    */
 275   int16_t tunnel GNUNET_PACKED;
 276
 277   /**
 278    * ID of the peer (can be local peer).
 279    */
 280   struct GNUNET_PeerIdentity destination;
 281
 282   /* If type == PEER (no 'S'): GNUNET_PeerIdentity paths[]
 283    * (each path ends in destination) */
 284 };
 285
 286
 287 /**
 288  * Message to inform the client about one of the tunnels in the service.
 289  */
 290 struct GNUNET_CADET_LocalInfoTunnel
 291 {
 292   /**
 293    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL
 294    * or #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS
 295    */
 296   struct GNUNET_MessageHeader header;
 297
 298   /**
 299    * Number of channels.
 300    */
 301   uint32_t channels GNUNET_PACKED;
 302
 303   /**
 304    * ID of the destination of the tunnel (can be local peer).
 305    */
 306   struct GNUNET_PeerIdentity destination;
 307
 308   /**
 309    * Number of connections.
 310    */
 311   uint32_t connections GNUNET_PACKED;
 312
 313   /**
 314    * Encryption state.
 315    */
 316   uint16_t estate GNUNET_PACKED;
 317
 318   /**
 319    * Connection state.
 320    */
 321   uint16_t cstate GNUNET_PACKED;
 322
 323   /* If TUNNEL (no 'S'): struct GNUNET_CADET_ConnectionTunnelIdentifier connection_ids[connections] */
 324   /* If TUNNEL (no 'S'): uint32_t channel_ids[channels] */
 325 };
 326
 327
 328 GNUNET_NETWORK_STRUCT_END
 329
 330
 331 /**
 332  * @brief Translate a fwd variable into a string representation, for logging.
 333  *
 334  * @param fwd Is FWD? (#GNUNET_YES or #GNUNET_NO)
 335  *
 336  * @return String representing FWD or BCK.
 337  */
 338 char *
 339 GC_f2s (int fwd);
 340
 341
 342 /**
 343  * Check if one pid is bigger than other, accounting for overflow.
 344  *
 345  * @param bigger Argument that should be bigger.
 346  * @param smaller Argument that should be smaller.
 347  *
 348  * @return True if bigger (arg1) has a higher value than smaller (arg 2).
 349  */
 350 int
 351 GC_is_pid_bigger (uint32_t bigger, uint32_t smaller);
 352
 353
 354 /**
 355  * Get the higher ACK value out of two values, taking in account overflow.
 356  *
 357  * @param a First ACK value.
 358  * @param b Second ACK value.
 359  *
 360  * @return Highest ACK value from the two.
 361  */
 362 uint32_t
 363 GC_max_pid (uint32_t a, uint32_t b);
 364
 365
 366 /**
 367  * Get the lower ACK value out of two values, taking in account overflow.
 368  *
 369  * @param a First ACK value.
 370  * @param b Second ACK value.
 371  *
 372  * @return Lowest ACK value from the two.
 373  */
 374 uint32_t
 375 GC_min_pid (uint32_t a, uint32_t b);
 376
 377
 378 /**
 379  * Allocate a string with a hexdump of any binary data.
 380  *
 381  * @param bin Arbitrary binary data.
 382  * @param len Length of @a bin in bytes.
 383  * @param output Where to write the output (if *output be NULL it's allocated).
 384  *
 385  * @return The size of the output.
 386  */
 387 size_t
 388 GC_bin2s (void *bin,
 389           unsigned int len,
 390           char **output);
 391
 392
 393 /**
 394  * Convert a message type into a string to help debug
 395  * Generated with:
 396  * FIND:        "#define ([^ ]+)[ ]*([0-9]+)"
 397  * REPLACE:     "    case \2: return "\1"; break;"
 398  *
 399  * @param m Message type.
 400  *
 401  * @return Human readable string description.
 402  */
 403 const char *
 404 GC_m2s (uint16_t m);
 405
 406 #if 0                           /* keep Emacsens' auto-indent happy */
 407 {
 408 #endif
 409 #ifdef __cplusplus
 410 }
 411 #endif
 412
 413 #endif