- pausing, unpausing
[oweals/gnunet.git] / 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    * Handle to NAT traversal support.
164    */
165   struct GNUNET_NAT_Handle *nat;
166
167   /**
168    * FD Read set
169    */
170   struct GNUNET_NETWORK_FDSet *rs_v4;
171
172   /**
173    * FD Write set
174    */
175   struct GNUNET_NETWORK_FDSet *ws_v4;
176
177
178   /**
179    * The read socket for IPv4
180    */
181   struct GNUNET_NETWORK_Handle *sockv4;
182
183
184   /**
185    * FD Read set
186    */
187   struct GNUNET_NETWORK_FDSet *rs_v6;
188
189   /**
190    * FD Write set
191    */
192   struct GNUNET_NETWORK_FDSet *ws_v6;
193
194   /**
195    * The read socket for IPv6
196    */
197   struct GNUNET_NETWORK_Handle *sockv6;
198
199   /**
200    * Beacon broadcasting
201    * -------------------
202    */
203
204   /**
205    * Broadcast interval
206    */
207   struct GNUNET_TIME_Relative broadcast_interval;
208
209   /**
210    * Broadcast with IPv4
211    */
212   int broadcast_ipv4;
213
214   /**
215    * Broadcast with IPv6
216    */
217   int broadcast_ipv6;
218
219
220   /**
221    * Tokenizer for inbound messages.
222    */
223   struct GNUNET_SERVER_MessageStreamTokenizer *broadcast_ipv6_mst;
224   struct GNUNET_SERVER_MessageStreamTokenizer *broadcast_ipv4_mst;
225
226   /**
227    * ID of select broadcast task
228    */
229   GNUNET_SCHEDULER_TaskIdentifier send_ipv4_broadcast_task;
230
231   /**
232    * ID of select broadcast task
233    */
234   GNUNET_SCHEDULER_TaskIdentifier send_ipv6_broadcast_task;
235
236   /**
237    * IPv6 multicast address
238    */
239   struct sockaddr_in6 ipv6_multicast_address;
240
241   /**
242    * DLL of IPv4 broadcast addresses
243    */
244   struct BroadcastAddress *ipv4_broadcast_tail;
245   struct BroadcastAddress *ipv4_broadcast_head;
246
247   /**
248    * Enable IPv6
249    */
250   int enable_ipv6;
251
252   /**
253    * Port we broadcasting on.
254    */
255   uint16_t broadcast_port;
256
257   /**
258    * Port we listen on.
259    */
260   uint16_t port;
261
262   /**
263    * Port we advertise on.
264    */
265   uint16_t aport;
266
267   struct UDPMessageWrapper *ipv4_queue_head;
268   struct UDPMessageWrapper *ipv4_queue_tail;
269
270   struct UDPMessageWrapper *ipv6_queue_head;
271   struct UDPMessageWrapper *ipv6_queue_tail;
272 };
273
274
275 const char *
276 udp_address_to_string (void *cls, const void *addr, size_t addrlen);
277
278 void
279 udp_broadcast_receive ();
280
281 void
282 setup_broadcast (struct Plugin *plugin, struct sockaddr_in6 *serverAddrv6, struct sockaddr_in *serverAddrv4);
283
284 void
285 stop_broadcast (struct Plugin *plugin);
286
287 /* end of plugin_transport_udp.h */