2 This file is part of GNUnet
3 Copyright (C) 2010-2014 GNUnet e.V.
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.
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.
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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
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
28 #ifndef PLUGIN_TRANSPORT_UDP_H
29 #define PLUGIN_TRANSPORT_UDP_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"
44 #define LOG(kind, ...) GNUNET_log_from (kind, "transport-udp", __VA_ARGS__)
46 #define PLUGIN_NAME "udp"
48 #define DEBUG_UDP GNUNET_NO
50 #define DEBUG_UDP_BROADCASTING GNUNET_NO
53 * MTU for fragmentation subsystem. Should be conservative since
54 * all communicating peers MUST work with this MTU.
59 GNUNET_NETWORK_STRUCT_BEGIN
61 * Network format for IPv4 addresses.
66 * Optional options and flags for this address
68 uint32_t options GNUNET_PACKED;
71 * IPv4 address, in network byte order.
73 uint32_t ipv4_addr GNUNET_PACKED;
76 * Port number, in network byte order.
78 uint16_t u4_port GNUNET_PACKED;
83 * Network format for IPv6 addresses.
88 * Optional options and flags for this address
90 uint32_t options GNUNET_PACKED;
95 struct in6_addr ipv6_addr GNUNET_PACKED;
98 * Port number, in network byte order.
100 uint16_t u6_port GNUNET_PACKED;
102 GNUNET_NETWORK_STRUCT_END
105 * Either an IPv4 or IPv6 UDP address. Note that without a "length",
106 * one cannot tell which one of the two types this address represents.
113 struct IPv4UdpAddress v4;
118 struct IPv6UdpAddress v6;
123 * Information we track for each message in the queue.
125 struct UDP_MessageWrapper;
129 * Closure for #append_port().
131 struct PrettyPrinterContext;
135 * Encapsulation of all of the state of the plugin.
142 struct GNUNET_TRANSPORT_PluginEnvironment *env;
145 * Session of peers with whom we are currently connected,
146 * map of peer identity to `struct GNUNET_ATS_Session *`.
148 struct GNUNET_CONTAINER_MultiPeerMap *sessions;
151 * Heap with all of our defragmentation activities.
153 struct GNUNET_CONTAINER_Heap *defrag_ctxs;
156 * ID of select task for IPv4
158 struct GNUNET_SCHEDULER_Task *select_task_v4;
161 * ID of select task for IPv6
163 struct GNUNET_SCHEDULER_Task *select_task_v6;
166 * Bandwidth tracker to limit global UDP traffic.
168 struct GNUNET_BANDWIDTH_Tracker tracker;
171 * Address we were told to bind to exclusively (IPv4).
176 * Address we were told to bind to exclusively (IPv6).
181 * Handle to NAT traversal support.
183 struct GNUNET_NAT_Handle *nat;
186 * Handle to NAT traversal support.
188 struct GNUNET_NAT_STUN_Handle *stun;
191 * The read socket for IPv4
193 struct GNUNET_NETWORK_Handle *sockv4;
196 * The read socket for IPv6
198 struct GNUNET_NETWORK_Handle *sockv6;
201 * Head of DLL of broadcast addresses
203 struct BroadcastAddress *broadcast_tail;
206 * Tail of DLL of broadcast addresses
208 struct BroadcastAddress *broadcast_head;
211 * Head of messages in IPv4 queue.
213 struct UDP_MessageWrapper *ipv4_queue_head;
216 * Tail of messages in IPv4 queue.
218 struct UDP_MessageWrapper *ipv4_queue_tail;
221 * Head of messages in IPv6 queue.
223 struct UDP_MessageWrapper *ipv6_queue_head;
226 * Tail of messages in IPv6 queue.
228 struct UDP_MessageWrapper *ipv6_queue_tail;
231 * Running pretty printers: head
233 struct PrettyPrinterContext *ppc_dll_head;
236 * Running pretty printers: tail
238 struct PrettyPrinterContext *ppc_dll_tail;
241 * Function to call about session status changes.
243 GNUNET_TRANSPORT_SessionInfoCallback sic;
246 * Closure for @e sic.
251 * IPv6 multicast address
253 struct sockaddr_in6 ipv6_multicast_address;
258 struct GNUNET_TIME_Relative broadcast_interval;
261 * Bytes currently in buffer
263 int64_t bytes_in_buffer;
271 * Is IPv6 enabled: #GNUNET_YES or #GNUNET_NO
276 * Is IPv4 enabled: #GNUNET_YES or #GNUNET_NO
281 * Is broadcasting enabled: #GNUNET_YES or #GNUNET_NO
283 int enable_broadcasting;
286 * Is receiving broadcasts enabled: #GNUNET_YES or #GNUNET_NO
288 int enable_broadcasting_receiving;
291 * Port we broadcasting on.
293 uint16_t broadcast_port;
301 * Port we advertise on.
308 * Function called for a quick conversion of the binary address to
309 * a numeric address. Note that the caller must not free the
310 * address and that the next call to this function is allowed
311 * to override the address again.
314 * @param addr binary address (a `union UdpAddress`)
315 * @param addrlen length of the @a addr
316 * @return string representing the same address
319 udp_address_to_string (void *cls,
325 * We received a broadcast message. Process it and all subsequent
326 * messages in the same packet.
328 * @param plugin the UDP plugin
329 * @param buf the buffer with the message(s)
330 * @param size number of bytes in @a buf
331 * @param udp_addr address of the sender
332 * @param udp_addr_len number of bytes in @a udp_addr
333 * @param network_type network type of the sender's address
336 udp_broadcast_receive (struct Plugin *plugin,
339 const union UdpAddress *udp_addr,
341 enum GNUNET_NetworkType network_type);
345 setup_broadcast (struct Plugin *plugin,
346 struct sockaddr_in6 *server_addrv6,
347 struct sockaddr_in *server_addrv4);
351 stop_broadcast (struct Plugin *plugin);
353 /*#ifndef PLUGIN_TRANSPORT_UDP_H*/
355 /* end of plugin_transport_udp.h */