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 it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  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        0x80000000U
  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_LocalChannelCreateMessage
 139 {
 140   /**
 141    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE
 142    *
 143    * Size: sizeof(struct GNUNET_CADET_ChannelOpenMessageMessage)
 144    */
 145   struct GNUNET_MessageHeader header;
 146
 147   /**
 148    * ID of a channel controlled by this client.
 149    */
 150   struct GNUNET_CADET_ClientChannelNumber ccn;
 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 or to a client to destroy tunnel.
 171  */
 172 struct GNUNET_CADET_LocalChannelDestroyMessage
 173 {
 174   /**
 175    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY
 176    */
 177   struct GNUNET_MessageHeader header;
 178
 179   /**
 180    * ID of a channel controlled by this client.
 181    */
 182   struct GNUNET_CADET_ClientChannelNumber ccn;
 183 };
 184
 185
 186 /**
 187  * Message for cadet data traffic.
 188  */
 189 struct GNUNET_CADET_LocalData
 190 {
 191   /**
 192    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA
 193    */
 194   struct GNUNET_MessageHeader header;
 195
 196   /**
 197    * ID of the channel
 198    */
 199   struct GNUNET_CADET_ClientChannelNumber ccn;
 200
 201   /**
 202    * Payload follows
 203    */
 204 };
 205
 206
 207 /**
 208  * Message to allow the client send more data to the service
 209  * (always service -> client).
 210  */
 211 struct GNUNET_CADET_LocalAck
 212 {
 213   /**
 214    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK
 215    */
 216   struct GNUNET_MessageHeader header;
 217
 218   /**
 219    * ID of the channel allowed to send more data.
 220    */
 221   struct GNUNET_CADET_ClientChannelNumber ccn;
 222
 223 };
 224
 225
 226 /**
 227  * Message to inform the client about channels in the service.
 228  *
 229  * TODO: split into two messages!
 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 ccn;
 243
 244   /**
 245    * ID of the destination of the channel (can be local peer).
 246    */
 247   struct GNUNET_PeerIdentity peer;
 248 };
 249
 250
 251 /**
 252  * Message to inform the client about channels in the service.
 253  */
 254 struct GNUNET_CADET_RequestPathInfoMessage
 255 {
 256   /**
 257    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_REQUEST_INFO_PATH
 258    */
 259   struct GNUNET_MessageHeader header;
 260
 261   /**
 262    * Always zero.
 263    */
 264   uint32_t resered GNUNET_PACKED;
 265
 266   /**
 267    * ID of the destination of the channel (can be local peer).
 268    */
 269   struct GNUNET_PeerIdentity peer;
 270 };
 271
 272
 273 /**
 274  * Message to inform the client about channels in the service.
 275  */
 276 struct GNUNET_CADET_ChannelInfoMessage
 277 {
 278   /**
 279    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL.
 280    */
 281   struct GNUNET_MessageHeader header;
 282
 283   /**
 284    * Root of the channel
 285    */
 286   struct GNUNET_PeerIdentity root;
 287
 288   /**
 289    * Destination of the channel
 290    */
 291   struct GNUNET_PeerIdentity dest;
 292
 293   /* FIXME: expand! */
 294 };
 295
 296
 297 /**
 298  * Message to as the service about information on a channel.
 299  */
 300 struct GNUNET_CADET_RequestChannelInfoMessage
 301 {
 302   /**
 303    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_REQUEST_INFO_CHANNEL.
 304    */
 305   struct GNUNET_MessageHeader header;
 306
 307   /**
 308    * Target of the channel.
 309    */
 310   struct GNUNET_PeerIdentity target;
 311
 312 };
 313
 314
 315 /**
 316  * Message to inform the client about one of the paths known to the service.
 317  */
 318 struct GNUNET_CADET_LocalInfoPath
 319 {
 320   /**
 321    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PATH.
 322    */
 323   struct GNUNET_MessageHeader header;
 324
 325   /**
 326    * Offset of the peer that was requested.
 327    */
 328   uint32_t off GNUNET_PACKED;
 329 };
 330
 331
 332 /**
 333  * Message to inform the client about one of the peers in the service.
 334  */
 335 struct GNUNET_CADET_LocalInfoPeers
 336 {
 337   /**
 338    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS
 339    */
 340   struct GNUNET_MessageHeader header;
 341
 342   /**
 343    * Number of paths.
 344    */
 345   uint16_t paths GNUNET_PACKED;
 346
 347   /**
 348    * Do we have a tunnel toward this peer?
 349    */
 350   int16_t tunnel GNUNET_PACKED;
 351
 352   /**
 353    * Shortest known path.
 354    */
 355   uint32_t best_path_length GNUNET_PACKED;
 356
 357   /**
 358    * ID of the peer (can be local peer).
 359    */
 360   struct GNUNET_PeerIdentity destination;
 361
 362 };
 363
 364
 365 /**
 366  * Message to inform the client about one of the tunnels in the service.
 367  *
 368  * TODO: split into two messages!
 369  */
 370 struct GNUNET_CADET_LocalInfoTunnel
 371 {
 372   /**
 373    * Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL
 374    * or #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS
 375    */
 376   struct GNUNET_MessageHeader header;
 377
 378   /**
 379    * Number of channels.
 380    */
 381   uint32_t channels GNUNET_PACKED;
 382
 383   /**
 384    * ID of the destination of the tunnel (can be local peer).
 385    */
 386   struct GNUNET_PeerIdentity destination;
 387
 388   /**
 389    * Number of connections.
 390    */
 391   uint32_t connections GNUNET_PACKED;
 392
 393   /**
 394    * Encryption state.
 395    */
 396   uint16_t estate GNUNET_PACKED;
 397
 398   /**
 399    * Connection state.
 400    */
 401   uint16_t cstate GNUNET_PACKED;
 402
 403   /* If TUNNEL (no 'S'): struct GNUNET_CADET_ConnectionTunnelIdentifier connection_ids[connections] */
 404   /* If TUNNEL (no 'S'): uint32_t channel_ids[channels] */
 405 };
 406
 407
 408 GNUNET_NETWORK_STRUCT_END
 409
 410
 411 /**
 412  * @brief Translate a fwd variable into a string representation, for logging.
 413  *
 414  * @param fwd Is FWD? (#GNUNET_YES or #GNUNET_NO)
 415  *
 416  * @return String representing FWD or BCK.
 417  */
 418 char *
 419 GC_f2s (int fwd);
 420
 421
 422 /**
 423  * Check if one pid is bigger than other, accounting for overflow.
 424  *
 425  * @param bigger Argument that should be bigger.
 426  * @param smaller Argument that should be smaller.
 427  *
 428  * @return True if bigger (arg1) has a higher value than smaller (arg 2).
 429  */
 430 int
 431 GC_is_pid_bigger (uint32_t bigger, uint32_t smaller);
 432
 433
 434 /**
 435  * Get the higher ACK value out of two values, taking in account overflow.
 436  *
 437  * @param a First ACK value.
 438  * @param b Second ACK value.
 439  *
 440  * @return Highest ACK value from the two.
 441  */
 442 uint32_t
 443 GC_max_pid (uint32_t a, uint32_t b);
 444
 445
 446 /**
 447  * Get the lower ACK value out of two values, taking in account overflow.
 448  *
 449  * @param a First ACK value.
 450  * @param b Second ACK value.
 451  *
 452  * @return Lowest ACK value from the two.
 453  */
 454 uint32_t
 455 GC_min_pid (uint32_t a, uint32_t b);
 456
 457
 458 /**
 459  * Allocate a string with a hexdump of any binary data.
 460  *
 461  * @param bin Arbitrary binary data.
 462  * @param len Length of @a bin in bytes.
 463  * @param output Where to write the output (if *output be NULL it's allocated).
 464  *
 465  * @return The size of the output.
 466  */
 467 size_t
 468 GC_bin2s (void *bin,
 469           unsigned int len,
 470           char **output);
 471
 472
 473 /**
 474  * Convert a message type into a string to help debug
 475  * Generated with:
 476  * FIND:        "#define ([^ ]+)[ ]*([0-9]+)"
 477  * REPLACE:     "    case \2: return "\1"; break;"
 478  *
 479  * @param m Message type.
 480  *
 481  * @return Human readable string description.
 482  */
 483 const char *
 484 GC_m2s (uint16_t m);
 485
 486 #if 0                           /* keep Emacsens' auto-indent happy */
 487 {
 488 #endif
 489 #ifdef __cplusplus
 490 }
 491 #endif
 492
 493 #endif