src/transport/plugin_transport_udp.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 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  * @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 #ifndef PLUGIN_TRANSPORT_UDP_H
  29 #define PLUGIN_TRANSPORT_UDP_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-udp", __VA_ARGS__)
  45
  46 #define PLUGIN_NAME "udp"
  47
  48 #define DEBUG_UDP GNUNET_NO
  49
  50 #define DEBUG_UDP_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 UDP_MTU 1400
  57
  58
  59 GNUNET_NETWORK_STRUCT_BEGIN
  60 /**
  61  * Network format for IPv4 addresses.
  62  */
  63 struct IPv4UdpAddress {
  64   /**
  65    * Optional options and flags for this address
  66    */
  67   uint32_t options GNUNET_PACKED;
  68
  69   /**
  70    * IPv4 address, in network byte order.
  71    */
  72   uint32_t ipv4_addr GNUNET_PACKED;
  73
  74   /**
  75    * Port number, in network byte order.
  76    */
  77   uint16_t u4_port GNUNET_PACKED;
  78 };
  79
  80
  81 /**
  82  * Network format for IPv6 addresses.
  83  */
  84 struct IPv6UdpAddress {
  85   /**
  86    * Optional options and flags for this address
  87    */
  88   uint32_t options GNUNET_PACKED;
  89
  90   /**
  91    * IPv6 address.
  92    */
  93   struct in6_addr ipv6_addr GNUNET_PACKED;
  94
  95   /**
  96    * Port number, in network byte order.
  97    */
  98   uint16_t u6_port GNUNET_PACKED;
  99 };
 100 GNUNET_NETWORK_STRUCT_END
 101
 102 /**
 103  * Either an IPv4 or IPv6 UDP address.  Note that without a "length",
 104  * one cannot tell which one of the two types this address represents.
 105  */
 106 union UdpAddress {
 107   /**
 108    * IPv4 case.
 109    */
 110   struct IPv4UdpAddress v4;
 111
 112   /**
 113    * IPv6 case.
 114    */
 115   struct IPv6UdpAddress v6;
 116 };
 117
 118
 119 /**
 120  * Information we track for each message in the queue.
 121  */
 122 struct UDP_MessageWrapper;
 123
 124
 125 /**
 126  * Closure for #append_port().
 127  */
 128 struct PrettyPrinterContext;
 129
 130
 131 /**
 132  * Encapsulation of all of the state of the plugin.
 133  */
 134 struct Plugin {
 135   /**
 136    * Our environment.
 137    */
 138   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 139
 140   /**
 141    * Session of peers with whom we are currently connected,
 142    * map of peer identity to `struct GNUNET_ATS_Session *`.
 143    */
 144   struct GNUNET_CONTAINER_MultiPeerMap *sessions;
 145
 146   /**
 147    * Heap with all of our defragmentation activities.
 148    */
 149   struct GNUNET_CONTAINER_Heap *defrag_ctxs;
 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    * Bandwidth tracker to limit global UDP traffic.
 163    */
 164   struct GNUNET_BANDWIDTH_Tracker tracker;
 165
 166   /**
 167    * Address we were told to bind to exclusively (IPv4).
 168    */
 169   char *bind4_address;
 170
 171   /**
 172    * Address we were told to bind to exclusively (IPv6).
 173    */
 174   char *bind6_address;
 175
 176   /**
 177    * Handle to NAT traversal support.
 178    */
 179   struct GNUNET_NAT_Handle *nat;
 180
 181   /**
 182    * Handle to NAT traversal support.
 183    */
 184   struct GNUNET_NAT_STUN_Handle *stun;
 185
 186   /**
 187    * The read socket for IPv4
 188    */
 189   struct GNUNET_NETWORK_Handle *sockv4;
 190
 191   /**
 192    * The read socket for IPv6
 193    */
 194   struct GNUNET_NETWORK_Handle *sockv6;
 195
 196   /**
 197    * Head of DLL of broadcast addresses
 198    */
 199   struct BroadcastAddress *broadcast_tail;
 200
 201   /**
 202    * Tail of DLL of broadcast addresses
 203    */
 204   struct BroadcastAddress *broadcast_head;
 205
 206   /**
 207    * Head of messages in IPv4 queue.
 208    */
 209   struct UDP_MessageWrapper *ipv4_queue_head;
 210
 211   /**
 212    * Tail of messages in IPv4 queue.
 213    */
 214   struct UDP_MessageWrapper *ipv4_queue_tail;
 215
 216   /**
 217    * Head of messages in IPv6 queue.
 218    */
 219   struct UDP_MessageWrapper *ipv6_queue_head;
 220
 221   /**
 222    * Tail of messages in IPv6 queue.
 223    */
 224   struct UDP_MessageWrapper *ipv6_queue_tail;
 225
 226   /**
 227    * Running pretty printers: head
 228    */
 229   struct PrettyPrinterContext *ppc_dll_head;
 230
 231   /**
 232    * Running pretty printers: tail
 233    */
 234   struct PrettyPrinterContext *ppc_dll_tail;
 235
 236   /**
 237    * Function to call about session status changes.
 238    */
 239   GNUNET_TRANSPORT_SessionInfoCallback sic;
 240
 241   /**
 242    * Closure for @e sic.
 243    */
 244   void *sic_cls;
 245
 246   /**
 247    * IPv6 multicast address
 248    */
 249   struct sockaddr_in6 ipv6_multicast_address;
 250
 251   /**
 252    * Broadcast interval
 253    */
 254   struct GNUNET_TIME_Relative broadcast_interval;
 255
 256   /**
 257    * Bytes currently in buffer
 258    */
 259   int64_t bytes_in_buffer;
 260
 261   /**
 262    * Address options
 263    */
 264   uint32_t myoptions;
 265
 266   /**
 267    * Is IPv6 enabled: #GNUNET_YES or #GNUNET_NO
 268    */
 269   int enable_ipv6;
 270
 271   /**
 272    * Is IPv4 enabled: #GNUNET_YES or #GNUNET_NO
 273    */
 274   int enable_ipv4;
 275
 276   /**
 277    * Is broadcasting enabled: #GNUNET_YES or #GNUNET_NO
 278    */
 279   int enable_broadcasting;
 280
 281   /**
 282    * Is receiving broadcasts enabled: #GNUNET_YES or #GNUNET_NO
 283    */
 284   int enable_broadcasting_receiving;
 285
 286   /**
 287    * Port we broadcasting on.
 288    */
 289   uint16_t broadcast_port;
 290
 291   /**
 292    * Port we listen on.
 293    */
 294   uint16_t port;
 295
 296   /**
 297    * Port we advertise on.
 298    */
 299   uint16_t aport;
 300 };
 301
 302
 303 /**
 304  * Function called for a quick conversion of the binary address to
 305  * a numeric address.  Note that the caller must not free the
 306  * address and that the next call to this function is allowed
 307  * to override the address again.
 308  *
 309  * @param cls closure
 310  * @param addr binary address (a `union UdpAddress`)
 311  * @param addrlen length of the @a addr
 312  * @return string representing the same address
 313  */
 314 const char *
 315 udp_address_to_string(void *cls,
 316                       const void *addr,
 317                       size_t addrlen);
 318
 319
 320 /**
 321  * We received a broadcast message.  Process it and all subsequent
 322  * messages in the same packet.
 323  *
 324  * @param plugin the UDP plugin
 325  * @param buf the buffer with the message(s)
 326  * @param size number of bytes in @a buf
 327  * @param udp_addr address of the sender
 328  * @param udp_addr_len number of bytes in @a udp_addr
 329  * @param network_type network type of the sender's address
 330  */
 331 void
 332 udp_broadcast_receive(struct Plugin *plugin,
 333                       const char *buf,
 334                       ssize_t size,
 335                       const union UdpAddress *udp_addr,
 336                       size_t udp_addr_len,
 337                       enum GNUNET_NetworkType network_type);
 338
 339
 340 void
 341 setup_broadcast(struct Plugin *plugin,
 342                 struct sockaddr_in6 *server_addrv6,
 343                 struct sockaddr_in *server_addrv4);
 344
 345
 346 void
 347 stop_broadcast(struct Plugin *plugin);
 348
 349 /*#ifndef PLUGIN_TRANSPORT_UDP_H*/
 350 #endif
 351 /* end of plugin_transport_udp.h */