src/transport/plugin_transport_xu.h

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2010-2014 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  * @file transport/plugin_transport_xu.h
  23  * @brief Implementation of the XU transport protocol
  24  * @author Christian Grothoff
  25  * @author Nathan Evans
  26  * @author Matthias Wachs
  27  */
  28 #ifndef PLUGIN_TRANSPORT_XU_H
  29 #define PLUGIN_TRANSPORT_XU_H
  30
  31 #include "platform.h"
  32 #include "gnunet_hello_lib.h"
  33 #include "gnunet_util_lib.h"
  34 #include "gnunet_fragmentation_lib.h"
  35 #include "gnunet_protocols.h"
  36 #include "gnunet_resolver_service.h"
  37 #include "gnunet_signatures.h"
  38 #include "gnunet_constants.h"
  39 #include "gnunet_statistics_service.h"
  40 #include "gnunet_transport_service.h"
  41 #include "gnunet_transport_plugin.h"
  42 #include "transport.h"
  43
  44 #define LOG(kind,...) GNUNET_log_from (kind, "transport-xu", __VA_ARGS__)
  45
  46 #define PLUGIN_NAME "xu"
  47
  48 #define DEBUG_XU GNUNET_NO
  49
  50 #define DEBUG_XU_BROADCASTING GNUNET_NO
  51
  52 /**
  53  * MTU for fragmentation subsystem.  Should be conservative since
  54  * all communicating peers MUST work with this MTU.
  55  */
  56 #define XU_MTU 1400
  57
  58
  59 GNUNET_NETWORK_STRUCT_BEGIN
  60 /**
  61  * Network format for IPv4 addresses.
  62  */
  63 struct IPv4XuAddress
  64 {
  65   /**
  66    * Optional options and flags for this address
  67    */
  68   uint32_t options GNUNET_PACKED;
  69
  70   /**
  71    * IPv4 address, in network byte order.
  72    */
  73   uint32_t ipv4_addr GNUNET_PACKED;
  74
  75   /**
  76    * Port number, in network byte order.
  77    */
  78   uint16_t u4_port GNUNET_PACKED;
  79 };
  80
  81
  82 /**
  83  * Network format for IPv6 addresses.
  84  */
  85 struct IPv6XuAddress
  86 {
  87   /**
  88    * Optional options and flags for this address
  89    */
  90   uint32_t options GNUNET_PACKED;
  91
  92   /**
  93    * IPv6 address.
  94    */
  95   struct in6_addr ipv6_addr GNUNET_PACKED;
  96
  97   /**
  98    * Port number, in network byte order.
  99    */
 100   uint16_t u6_port GNUNET_PACKED;
 101 };
 102 GNUNET_NETWORK_STRUCT_END
 103
 104 /**
 105  * Either an IPv4 or IPv6 XU address.  Note that without a "length",
 106  * one cannot tell which one of the two types this address represents.
 107  */
 108 union XuAddress
 109 {
 110   /**
 111    * IPv4 case.
 112    */
 113   struct IPv4XuAddress v4;
 114
 115   /**
 116    * IPv6 case.
 117    */
 118   struct IPv6XuAddress v6;
 119 };
 120
 121
 122 /**
 123  * Information we track for each message in the queue.
 124  */
 125 struct XU_MessageWrapper;
 126
 127
 128 /**
 129  * Closure for #append_port().
 130  */
 131 struct PrettyPrinterContext;
 132
 133
 134 /**
 135  * Encapsulation of all of the state of the plugin.
 136  */
 137 struct Plugin
 138 {
 139
 140   /**
 141    * Our environment.
 142    */
 143   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 144
 145   /**
 146    * Session of peers with whom we are currently connected,
 147    * map of peer identity to `struct GNUNET_ATS_Session *`.
 148    */
 149   struct GNUNET_CONTAINER_MultiPeerMap *sessions;
 150
 151   /**
 152    * ID of select task for IPv4
 153    */
 154   struct GNUNET_SCHEDULER_Task *select_task_v4;
 155
 156   /**
 157    * ID of select task for IPv6
 158    */
 159   struct GNUNET_SCHEDULER_Task *select_task_v6;
 160
 161   /**
 162    * Address we were told to bind to exclusively (IPv4).
 163    */
 164   char *bind4_address;
 165
 166   /**
 167    * Address we were told to bind to exclusively (IPv6).
 168    */
 169   char *bind6_address;
 170
 171   /**
 172    * Handle to NAT traversal support.
 173    */
 174   struct GNUNET_NAT_Handle *nat;
 175
 176   /**
 177    * Handle to NAT traversal support.
 178    */
 179   struct GNUNET_NAT_STUN_Handle *stun;
 180
 181   /**
 182    * The read socket for IPv4
 183    */
 184   struct GNUNET_NETWORK_Handle *sockv4;
 185
 186   /**
 187    * The read socket for IPv6
 188    */
 189   struct GNUNET_NETWORK_Handle *sockv6;
 190
 191   /**
 192    * Running pretty printers: head
 193    */
 194   struct PrettyPrinterContext *ppc_dll_head;
 195
 196   /**
 197    * Running pretty printers: tail
 198    */
 199   struct PrettyPrinterContext *ppc_dll_tail;
 200
 201   /**
 202    * Function to call about session status changes.
 203    */
 204   GNUNET_TRANSPORT_SessionInfoCallback sic;
 205
 206   /**
 207    * Closure for @e sic.
 208    */
 209   void *sic_cls;
 210
 211   /**
 212    * IPv6 multicast address
 213    */
 214   struct sockaddr_in6 ipv6_multicast_address;
 215
 216   /**
 217    * Broadcast interval
 218    */
 219   struct GNUNET_TIME_Relative broadcast_interval;
 220
 221   /**
 222    * Bytes currently in buffer
 223    */
 224   int64_t bytes_in_buffer;
 225
 226   /**
 227    * Address options
 228    */
 229   uint32_t myoptions;
 230
 231   /**
 232    * Is IPv6 enabled: #GNUNET_YES or #GNUNET_NO
 233    */
 234   int enable_ipv6;
 235
 236   /**
 237    * Is IPv4 enabled: #GNUNET_YES or #GNUNET_NO
 238    */
 239   int enable_ipv4;
 240
 241   /**
 242    * Port we listen on.
 243    */
 244   uint16_t port;
 245
 246   /**
 247    * Port we advertise on.
 248    */
 249   uint16_t aport;
 250
 251 };
 252
 253
 254 /**
 255  * Function called for a quick conversion of the binary address to
 256  * a numeric address.  Note that the caller must not free the
 257  * address and that the next call to this function is allowed
 258  * to override the address again.
 259  *
 260  * @param cls closure
 261  * @param addr binary address (a `union XuAddress`)
 262  * @param addrlen length of the @a addr
 263  * @return string representing the same address
 264  */
 265 const char *
 266 xu_address_to_string (void *cls,
 267                        const void *addr,
 268                        size_t addrlen);
 269
 270
 271 /*#ifndef PLUGIN_TRANSPORT_XU_H*/
 272 #endif
 273 /* end of plugin_transport_xu.h */