src/transport/plugin_transport_udp.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2010, 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  * @file transport/plugin_transport_udp.h
  23  * @brief Implementation of the UDP transport protocol
  24  * @author Christian Grothoff
  25  * @author Nathan Evans
  26  * @author Matthias Wachs
  27  */
  28 #include "platform.h"
  29 #include "gnunet_hello_lib.h"
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_fragmentation_lib.h"
  32 #include "gnunet_nat_lib.h"
  33 #include "gnunet_protocols.h"
  34 #include "gnunet_resolver_service.h"
  35 #include "gnunet_signatures.h"
  36 #include "gnunet_constants.h"
  37 #include "gnunet_statistics_service.h"
  38 #include "gnunet_transport_service.h"
  39 #include "gnunet_transport_plugin.h"
  40 #include "transport.h"
  41
  42 #define LOG(kind,...) GNUNET_log_from (kind, "transport-udp", __VA_ARGS__)
  43
  44 #define DEBUG_UDP GNUNET_NO
  45 #define DEBUG_UDP_BROADCASTING GNUNET_NO
  46
  47 /**
  48  * MTU for fragmentation subsystem.  Should be conservative since
  49  * all communicating peers MUST work with this MTU.
  50  */
  51 #define UDP_MTU 1400
  52
  53
  54 GNUNET_NETWORK_STRUCT_BEGIN
  55 /**
  56  * Network format for IPv4 addresses.
  57  */
  58 struct IPv4UdpAddress
  59 {
  60   /**
  61    * Optional options and flags for this address
  62    */
  63   uint32_t options GNUNET_PACKED;
  64
  65   /**
  66    * IPv4 address, in network byte order.
  67    */
  68   uint32_t ipv4_addr GNUNET_PACKED;
  69
  70   /**
  71    * Port number, in network byte order.
  72    */
  73   uint16_t u4_port GNUNET_PACKED;
  74 };
  75
  76
  77 /**
  78  * Network format for IPv6 addresses.
  79  */
  80 struct IPv6UdpAddress
  81 {
  82   /**
  83    * Optional options and flags for this address
  84    */
  85   uint32_t options GNUNET_PACKED;
  86
  87   /**
  88    * IPv6 address.
  89    */
  90   struct in6_addr ipv6_addr GNUNET_PACKED;
  91
  92   /**
  93    * Port number, in network byte order.
  94    */
  95   uint16_t u6_port GNUNET_PACKED;
  96 };
  97 GNUNET_NETWORK_STRUCT_END
  98
  99
 100 /**
 101  * UDP Message-Packet header (after defragmentation).
 102  */
 103 struct UDPMessage
 104 {
 105   /**
 106    * Message header.
 107    */
 108   struct GNUNET_MessageHeader header;
 109
 110   /**
 111    * Always zero for now.
 112    */
 113   uint32_t reserved;
 114
 115   /**
 116    * What is the identity of the sender
 117    */
 118   struct GNUNET_PeerIdentity sender;
 119
 120 };
 121
 122
 123 /**
 124  * Encapsulation of all of the state of the plugin.
 125  */
 126 struct Plugin
 127 {
 128
 129   /**
 130    * Our environment.
 131    */
 132   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 133
 134   /**
 135    * Session of peers with whom we are currently connected,
 136    * map of peer identity to 'struct PeerSession'.
 137    */
 138   struct GNUNET_CONTAINER_MultiPeerMap *sessions;
 139
 140   /**
 141    * Heap with all of our defragmentation activities.
 142    */
 143   struct GNUNET_CONTAINER_Heap *defrag_ctxs;
 144
 145   /**
 146    * ID of select task
 147    */
 148   GNUNET_SCHEDULER_TaskIdentifier select_task;
 149   GNUNET_SCHEDULER_TaskIdentifier select_task_v6;
 150
 151   /**
 152    * Tokenizer for inbound messages.
 153    */
 154   struct GNUNET_SERVER_MessageStreamTokenizer *mst;
 155
 156   /**
 157    * Bandwidth tracker to limit global UDP traffic.
 158    */
 159   struct GNUNET_BANDWIDTH_Tracker tracker;
 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   /**
 173    * Bytes currently in buffer
 174    */
 175   int64_t bytes_in_buffer;
 176
 177   /**
 178    * Handle to NAT traversal support.
 179    */
 180   struct GNUNET_NAT_Handle *nat;
 181
 182   /**
 183    * FD Read set
 184    */
 185   struct GNUNET_NETWORK_FDSet *rs_v4;
 186
 187   /**
 188    * FD Write set
 189    */
 190   struct GNUNET_NETWORK_FDSet *ws_v4;
 191
 192
 193   /**
 194    * The read socket for IPv4
 195    */
 196   struct GNUNET_NETWORK_Handle *sockv4;
 197
 198
 199   /**
 200    * FD Read set
 201    */
 202   struct GNUNET_NETWORK_FDSet *rs_v6;
 203
 204   /**
 205    * FD Write set
 206    */
 207   struct GNUNET_NETWORK_FDSet *ws_v6;
 208
 209   /**
 210    * The read socket for IPv6
 211    */
 212   struct GNUNET_NETWORK_Handle *sockv6;
 213
 214   /**
 215    * Beacon broadcasting
 216    * -------------------
 217    */
 218
 219   /**
 220    * Broadcast interval
 221    */
 222   struct GNUNET_TIME_Relative broadcast_interval;
 223
 224   /**
 225    * Tokenizer for inbound messages.
 226    */
 227   struct GNUNET_SERVER_MessageStreamTokenizer *broadcast_ipv6_mst;
 228   struct GNUNET_SERVER_MessageStreamTokenizer *broadcast_ipv4_mst;
 229
 230   /**
 231    * IPv6 multicast address
 232    */
 233   struct sockaddr_in6 ipv6_multicast_address;
 234
 235   /**
 236    * DLL of broadcast addresses
 237    */
 238   struct BroadcastAddress *broadcast_tail;
 239   struct BroadcastAddress *broadcast_head;
 240
 241   /**
 242    * Is IPv6 enabled: GNUNET_YES or GNUNET_NO
 243    */
 244   int enable_ipv6;
 245
 246   /**
 247    * Is IPv4 enabled: GNUNET_YES or GNUNET_NO
 248    */
 249   int enable_ipv4;
 250
 251   /**
 252    * Port we broadcasting on.
 253    */
 254   uint16_t broadcast_port;
 255
 256   /**
 257    * Port we listen on.
 258    */
 259   uint16_t port;
 260
 261   /**
 262    * Port we advertise on.
 263    */
 264   uint16_t aport;
 265
 266   struct UDP_MessageWrapper *ipv4_queue_head;
 267   struct UDP_MessageWrapper *ipv4_queue_tail;
 268
 269   struct UDP_MessageWrapper *ipv6_queue_head;
 270   struct UDP_MessageWrapper *ipv6_queue_tail;
 271 };
 272
 273
 274 const char *
 275 udp_address_to_string (void *cls, const void *addr, size_t addrlen);
 276
 277 void
 278 udp_broadcast_receive (struct Plugin *plugin,
 279                        const char * buf,
 280                        ssize_t size,
 281                        const struct sockaddr *addr,
 282                        size_t addrlen);
 283
 284 void
 285 setup_broadcast (struct Plugin *plugin,
 286                  struct sockaddr_in6 *server_addrv6,
 287                  struct sockaddr_in *server_addrv4);
 288
 289 void
 290 stop_broadcast (struct Plugin *plugin);
 291
 292 /* end of plugin_transport_udp.h */