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    * IPv4 address, in network byte order.
  62    */
  63   uint32_t ipv4_addr GNUNET_PACKED;
  64
  65   /**
  66    * Port number, in network byte order.
  67    */
  68   uint16_t u4_port GNUNET_PACKED;
  69 };
  70
  71
  72 /**
  73  * Network format for IPv6 addresses.
  74  */
  75 struct IPv6UdpAddress
  76 {
  77
  78   /**
  79    * IPv6 address.
  80    */
  81   struct in6_addr ipv6_addr GNUNET_PACKED;
  82
  83   /**
  84    * Port number, in network byte order.
  85    */
  86   uint16_t u6_port GNUNET_PACKED;
  87 };
  88 GNUNET_NETWORK_STRUCT_END
  89
  90
  91 /**
  92  * UDP Message-Packet header (after defragmentation).
  93  */
  94 struct UDPMessage
  95 {
  96   /**
  97    * Message header.
  98    */
  99   struct GNUNET_MessageHeader header;
 100
 101   /**
 102    * Always zero for now.
 103    */
 104   uint32_t reserved;
 105
 106   /**
 107    * What is the identity of the sender
 108    */
 109   struct GNUNET_PeerIdentity sender;
 110
 111 };
 112
 113
 114 /**
 115  * Encapsulation of all of the state of the plugin.
 116  */
 117 struct Plugin
 118 {
 119
 120   /**
 121    * Our environment.
 122    */
 123   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 124
 125   /**
 126    * Session of peers with whom we are currently connected,
 127    * map of peer identity to 'struct PeerSession'.
 128    */
 129   struct GNUNET_CONTAINER_MultiHashMap *sessions;
 130
 131   /**
 132    * Heap with all of our defragmentation activities.
 133    */
 134   struct GNUNET_CONTAINER_Heap *defrag_ctxs;
 135
 136   /**
 137    * ID of select task
 138    */
 139   GNUNET_SCHEDULER_TaskIdentifier select_task;
 140   GNUNET_SCHEDULER_TaskIdentifier select_task_v6;
 141
 142   /**
 143    * Tokenizer for inbound messages.
 144    */
 145   struct GNUNET_SERVER_MessageStreamTokenizer *mst;
 146
 147   /**
 148    * Bandwidth tracker to limit global UDP traffic.
 149    */
 150   struct GNUNET_BANDWIDTH_Tracker tracker;
 151
 152   /**
 153    * Address we were told to bind to exclusively (IPv4).
 154    */
 155   char *bind4_address;
 156
 157   /**
 158    * Address we were told to bind to exclusively (IPv6).
 159    */
 160   char *bind6_address;
 161
 162
 163   /**
 164    * Bytes currently in buffer
 165    */
 166   int64_t bytes_in_buffer;
 167
 168   /**
 169    * Handle to NAT traversal support.
 170    */
 171   struct GNUNET_NAT_Handle *nat;
 172
 173   /**
 174    * FD Read set
 175    */
 176   struct GNUNET_NETWORK_FDSet *rs_v4;
 177
 178   /**
 179    * FD Write set
 180    */
 181   struct GNUNET_NETWORK_FDSet *ws_v4;
 182
 183
 184   /**
 185    * The read socket for IPv4
 186    */
 187   struct GNUNET_NETWORK_Handle *sockv4;
 188
 189
 190   /**
 191    * FD Read set
 192    */
 193   struct GNUNET_NETWORK_FDSet *rs_v6;
 194
 195   /**
 196    * FD Write set
 197    */
 198   struct GNUNET_NETWORK_FDSet *ws_v6;
 199
 200   /**
 201    * The read socket for IPv6
 202    */
 203   struct GNUNET_NETWORK_Handle *sockv6;
 204
 205   /**
 206    * Beacon broadcasting
 207    * -------------------
 208    */
 209
 210   /**
 211    * Broadcast interval
 212    */
 213   struct GNUNET_TIME_Relative broadcast_interval;
 214
 215   /**
 216    * Broadcast with IPv4
 217    */
 218   int broadcast_ipv4;
 219
 220   /**
 221    * Broadcast with IPv6
 222    */
 223   int broadcast_ipv6;
 224
 225
 226   /**
 227    * Tokenizer for inbound messages.
 228    */
 229   struct GNUNET_SERVER_MessageStreamTokenizer *broadcast_ipv6_mst;
 230   struct GNUNET_SERVER_MessageStreamTokenizer *broadcast_ipv4_mst;
 231
 232   /**
 233    * ID of select broadcast task
 234    */
 235   GNUNET_SCHEDULER_TaskIdentifier send_ipv4_broadcast_task;
 236
 237   /**
 238    * ID of select broadcast task
 239    */
 240   GNUNET_SCHEDULER_TaskIdentifier send_ipv6_broadcast_task;
 241
 242   /**
 243    * IPv6 multicast address
 244    */
 245   struct sockaddr_in6 ipv6_multicast_address;
 246
 247   /**
 248    * DLL of IPv4 broadcast addresses
 249    */
 250   struct BroadcastAddress *ipv4_broadcast_tail;
 251   struct BroadcastAddress *ipv4_broadcast_head;
 252
 253   /**
 254    * Enable IPv6
 255    */
 256   int enable_ipv6;
 257
 258   /**
 259    * Port we broadcasting on.
 260    */
 261   uint16_t broadcast_port;
 262
 263   /**
 264    * Port we listen on.
 265    */
 266   uint16_t port;
 267
 268   /**
 269    * Port we advertise on.
 270    */
 271   uint16_t aport;
 272
 273   struct UDP_MessageWrapper *ipv4_queue_head;
 274   struct UDP_MessageWrapper *ipv4_queue_tail;
 275
 276   struct UDP_MessageWrapper *ipv6_queue_head;
 277   struct UDP_MessageWrapper *ipv6_queue_tail;
 278 };
 279
 280
 281 const char *
 282 udp_address_to_string (void *cls, const void *addr, size_t addrlen);
 283
 284 void
 285 udp_broadcast_receive ();
 286
 287 void
 288 setup_broadcast (struct Plugin *plugin, struct sockaddr_in6 *serverAddrv6, struct sockaddr_in *serverAddrv4);
 289
 290 void
 291 stop_broadcast (struct Plugin *plugin);
 292
 293 /* end of plugin_transport_udp.h */