-smoother calculation of flow delays, base it on the current message not the previous one
[oweals/gnunet.git] / src / transport / plugin_transport_udp.c
1 /*
2  This file is part of GNUnet
3  Copyright (C) 2010-2015 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., 51 Franklin Street, Fifth Floor,
18  Boston, MA 02110-1301, USA.
19  */
20
21 /**
22  * @file transport/plugin_transport_udp.c
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 "plugin_transport_udp.h"
30 #include "gnunet_hello_lib.h"
31 #include "gnunet_util_lib.h"
32 #include "gnunet_fragmentation_lib.h"
33 #include "gnunet_nat_lib.h"
34 #include "gnunet_protocols.h"
35 #include "gnunet_resolver_service.h"
36 #include "gnunet_signatures.h"
37 #include "gnunet_constants.h"
38 #include "gnunet_statistics_service.h"
39 #include "gnunet_transport_service.h"
40 #include "gnunet_transport_plugin.h"
41 #include "transport.h"
42
43 #define LOG(kind,...) GNUNET_log_from (kind, "transport-udp", __VA_ARGS__)
44
45 /**
46  * After how much inactivity should a UDP session time out?
47  */
48 #define UDP_SESSION_TIME_OUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
49
50 /**
51  * Number of messages we can defragment in parallel.  We only really
52  * defragment 1 message at a time, but if messages get re-ordered, we
53  * may want to keep knowledge about the previous message to avoid
54  * discarding the current message in favor of a single fragment of a
55  * previous message.  3 should be good since we don't expect massive
56  * message reorderings with UDP.
57  */
58 #define UDP_MAX_MESSAGES_IN_DEFRAG 3
59
60 /**
61  * We keep a defragmentation queue per sender address.  How many
62  * sender addresses do we support at the same time? Memory consumption
63  * is roughly a factor of 32k * #UDP_MAX_MESSAGES_IN_DEFRAG times this
64  * value. (So 128 corresponds to 12 MB and should suffice for
65  * connecting to roughly 128 peers via UDP).
66  */
67 #define UDP_MAX_SENDER_ADDRESSES_WITH_DEFRAG 128
68
69
70 /**
71  * UDP Message-Packet header (after defragmentation).
72  */
73 struct UDPMessage
74 {
75   /**
76    * Message header.
77    */
78   struct GNUNET_MessageHeader header;
79
80   /**
81    * Always zero for now.
82    */
83   uint32_t reserved;
84
85   /**
86    * What is the identity of the sender
87    */
88   struct GNUNET_PeerIdentity sender;
89
90 };
91
92
93 /**
94  * Closure for #append_port().
95  */
96 struct PrettyPrinterContext
97 {
98   /**
99    * DLL
100    */
101   struct PrettyPrinterContext *next;
102
103   /**
104    * DLL
105    */
106   struct PrettyPrinterContext *prev;
107
108   /**
109    * Our plugin.
110    */
111   struct Plugin *plugin;
112
113   /**
114    * Resolver handle
115    */
116   struct GNUNET_RESOLVER_RequestHandle *resolver_handle;
117
118   /**
119    * Function to call with the result.
120    */
121   GNUNET_TRANSPORT_AddressStringCallback asc;
122
123   /**
124    * Clsoure for @e asc.
125    */
126   void *asc_cls;
127
128   /**
129    * Timeout task
130    */
131   struct GNUNET_SCHEDULER_Task *timeout_task;
132
133   /**
134    * Is this an IPv6 address?
135    */
136   int ipv6;
137
138   /**
139    * Options
140    */
141   uint32_t options;
142
143   /**
144    * Port to add after the IP address.
145    */
146   uint16_t port;
147
148 };
149
150
151 /**
152  * Session with another peer.
153  */
154 struct GNUNET_ATS_Session
155 {
156   /**
157    * Which peer is this session for?
158    */
159   struct GNUNET_PeerIdentity target;
160
161   /**
162    * Plugin this session belongs to.
163    */
164   struct Plugin *plugin;
165
166   /**
167    * Context for dealing with fragments.
168    */
169   struct UDP_FragmentationContext *frag_ctx;
170
171   /**
172    * Desired delay for next sending we send to other peer
173    */
174   struct GNUNET_TIME_Relative flow_delay_for_other_peer;
175
176   /**
177    * Desired delay for transmissions we received from other peer.
178    * This is for full messages, the value needs to be adjusted for
179    * fragmented messages.
180    */
181   struct GNUNET_TIME_Relative flow_delay_from_other_peer;
182
183   /**
184    * Session timeout task
185    */
186   struct GNUNET_SCHEDULER_Task *timeout_task;
187
188   /**
189    * When does this session time out?
190    */
191   struct GNUNET_TIME_Absolute timeout;
192
193   /**
194    * What time did we last transmit?
195    */
196   struct GNUNET_TIME_Absolute last_transmit_time;
197
198   /**
199    * expected delay for ACKs
200    */
201   struct GNUNET_TIME_Relative last_expected_ack_delay;
202
203   /**
204    * desired delay between UDP messages
205    */
206   struct GNUNET_TIME_Relative last_expected_msg_delay;
207
208   /**
209    * Our own address.
210    */
211   struct GNUNET_HELLO_Address *address;
212
213   /**
214    * Number of bytes waiting for transmission to this peer.
215    */
216   unsigned long long bytes_in_queue;
217
218   /**
219    * Number of messages waiting for transmission to this peer.
220    */
221   unsigned int msgs_in_queue;
222
223   /**
224    * Reference counter to indicate that this session is
225    * currently being used and must not be destroyed;
226    * setting @e in_destroy will destroy it as soon as
227    * possible.
228    */
229   unsigned int rc;
230
231   /**
232    * Network type of the address.
233    */
234   enum GNUNET_ATS_Network_Type scope;
235
236   /**
237    * Is this session about to be destroyed (sometimes we cannot
238    * destroy a session immediately as below us on the stack
239    * there might be code that still uses it; in this case,
240    * @e rc is non-zero).
241    */
242   int in_destroy;
243 };
244
245
246
247 /**
248  * Data structure to track defragmentation contexts based
249  * on the source of the UDP traffic.
250  */
251 struct DefragContext
252 {
253
254   /**
255    * Defragmentation context.
256    */
257   struct GNUNET_DEFRAGMENT_Context *defrag;
258
259   /**
260    * Reference to master plugin struct.
261    */
262   struct Plugin *plugin;
263
264   /**
265    * Node in the defrag heap.
266    */
267   struct GNUNET_CONTAINER_HeapNode *hnode;
268
269   /**
270    * Source address this receive context is for (allocated at the
271    * end of the struct).
272    */
273   const union UdpAddress *udp_addr;
274
275   /**
276    * Who's message(s) are we defragmenting here?
277    * Only initialized once we succeeded and
278    * @e have_sender is set.
279    */
280   struct GNUNET_PeerIdentity sender;
281
282   /**
283    * Length of @e udp_addr.
284    */
285   size_t udp_addr_len;
286
287   /**
288    * Network type the address belongs to.
289    */
290   enum GNUNET_ATS_Network_Type network_type;
291
292   /**
293    * Has the @e sender field been initialized yet?
294    */
295   int have_sender;
296 };
297
298
299 /**
300  * Context to send fragmented messages
301  */
302 struct UDP_FragmentationContext
303 {
304   /**
305    * Next in linked list
306    */
307   struct UDP_FragmentationContext *next;
308
309   /**
310    * Previous in linked list
311    */
312   struct UDP_FragmentationContext *prev;
313
314   /**
315    * The plugin
316    */
317   struct Plugin *plugin;
318
319   /**
320    * Handle for fragmentation.
321    */
322   struct GNUNET_FRAGMENT_Context *frag;
323
324   /**
325    * The session this fragmentation context belongs to
326    */
327   struct GNUNET_ATS_Session *session;
328
329   /**
330    * Function to call upon completion of the transmission.
331    */
332   GNUNET_TRANSPORT_TransmitContinuation cont;
333
334   /**
335    * Closure for @e cont.
336    */
337   void *cont_cls;
338
339   /**
340    * Start time.
341    */
342   struct GNUNET_TIME_Absolute start_time;
343
344   /**
345    * Transmission time for the next fragment.  Incremented by
346    * the @e flow_delay_from_other_peer for each fragment when
347    * we setup the fragments.
348    */
349   struct GNUNET_TIME_Absolute next_frag_time;
350
351   /**
352    * Desired delay for transmissions we received from other peer.
353    * Adjusted to be per fragment (UDP_MTU), even though on the
354    * wire it was for "full messages".
355    */
356   struct GNUNET_TIME_Relative flow_delay_from_other_peer;
357
358   /**
359    * Message timeout
360    */
361   struct GNUNET_TIME_Absolute timeout;
362
363   /**
364    * Payload size of original unfragmented message
365    */
366   size_t payload_size;
367
368   /**
369    * Bytes used to send all fragments on wire including UDP overhead
370    */
371   size_t on_wire_size;
372
373 };
374
375
376 /**
377  * Function called when a message is removed from the
378  * transmission queue.
379  *
380  * @param cls closure
381  * @param udpw message wrapper finished
382  * @param result #GNUNET_OK on success (message was sent)
383  *               #GNUNET_SYSERR if the target disconnected
384  *               or we had a timeout or other trouble sending
385  */
386 typedef void
387 (*QueueContinuation) (void *cls,
388                       struct UDP_MessageWrapper *udpw,
389                       int result);
390
391
392 /**
393  * Information we track for each message in the queue.
394  */
395 struct UDP_MessageWrapper
396 {
397   /**
398    * Session this message belongs to
399    */
400   struct GNUNET_ATS_Session *session;
401
402   /**
403    * DLL of messages, previous element
404    */
405   struct UDP_MessageWrapper *prev;
406
407   /**
408    * DLL of messages, next element
409    */
410   struct UDP_MessageWrapper *next;
411
412   /**
413    * Message with @e msg_size bytes including UDP-specific overhead.
414    */
415   char *msg_buf;
416
417   /**
418    * Function to call once the message wrapper is being removed
419    * from the queue (with success or failure).
420    */
421   QueueContinuation qc;
422
423   /**
424    * Closure for @e qc.
425    */
426   void *qc_cls;
427
428   /**
429    * External continuation to call upon completion of the
430    * transmission, NULL if this queue entry is not for a
431    * message from the application.
432    */
433   GNUNET_TRANSPORT_TransmitContinuation cont;
434
435   /**
436    * Closure for @e cont.
437    */
438   void *cont_cls;
439
440   /**
441    * Fragmentation context.
442    * frag_ctx == NULL if transport <= MTU
443    * frag_ctx != NULL if transport > MTU
444    */
445   struct UDP_FragmentationContext *frag_ctx;
446
447   /**
448    * Message enqueue time.
449    */
450   struct GNUNET_TIME_Absolute start_time;
451
452   /**
453    * Desired transmission time for this message, based on the
454    * flow limiting information we got from the other peer.
455    */
456   struct GNUNET_TIME_Absolute transmission_time;
457
458   /**
459    * Message timeout.
460    */
461   struct GNUNET_TIME_Absolute timeout;
462
463   /**
464    * Size of UDP message to send, including UDP-specific overhead.
465    */
466   size_t msg_size;
467
468   /**
469    * Payload size of original message.
470    */
471   size_t payload_size;
472
473 };
474
475
476 GNUNET_NETWORK_STRUCT_BEGIN
477
478 /**
479  * UDP ACK Message-Packet header.
480  */
481 struct UDP_ACK_Message
482 {
483   /**
484    * Message header.
485    */
486   struct GNUNET_MessageHeader header;
487
488   /**
489    * Desired delay for flow control, in us (in NBO).
490    * A value of UINT32_MAX indicates that the other
491    * peer wants us to disconnect.
492    */
493   uint32_t delay GNUNET_PACKED;
494
495   /**
496    * What is the identity of the sender
497    */
498   struct GNUNET_PeerIdentity sender;
499
500 };
501
502 GNUNET_NETWORK_STRUCT_END
503
504
505 /* ************************* Monitoring *********** */
506
507
508 /**
509  * If a session monitor is attached, notify it about the new
510  * session state.
511  *
512  * @param plugin our plugin
513  * @param session session that changed state
514  * @param state new state of the session
515  */
516 static void
517 notify_session_monitor (struct Plugin *plugin,
518                         struct GNUNET_ATS_Session *session,
519                         enum GNUNET_TRANSPORT_SessionState state)
520 {
521   struct GNUNET_TRANSPORT_SessionInfo info;
522
523   if (NULL == plugin->sic)
524     return;
525   if (GNUNET_YES == session->in_destroy)
526     return; /* already destroyed, just RC>0 left-over actions */
527   memset (&info,
528           0,
529           sizeof (info));
530   info.state = state;
531   info.is_inbound = GNUNET_SYSERR; /* hard to say */
532   info.num_msg_pending = session->msgs_in_queue;
533   info.num_bytes_pending = session->bytes_in_queue;
534   /* info.receive_delay remains zero as this is not supported by UDP
535      (cannot selectively not receive from 'some' peer while continuing
536      to receive from others) */
537   info.session_timeout = session->timeout;
538   info.address = session->address;
539   plugin->sic (plugin->sic_cls,
540                session,
541                &info);
542 }
543
544
545 /**
546  * Return information about the given session to the monitor callback.
547  *
548  * @param cls the `struct Plugin` with the monitor callback (`sic`)
549  * @param peer peer we send information about
550  * @param value our `struct GNUNET_ATS_Session` to send information about
551  * @return #GNUNET_OK (continue to iterate)
552  */
553 static int
554 send_session_info_iter (void *cls,
555                         const struct GNUNET_PeerIdentity *peer,
556                         void *value)
557 {
558   struct Plugin *plugin = cls;
559   struct GNUNET_ATS_Session *session = value;
560
561   notify_session_monitor (plugin,
562                           session,
563                           GNUNET_TRANSPORT_SS_INIT);
564   notify_session_monitor (plugin,
565                           session,
566                           GNUNET_TRANSPORT_SS_UP);
567   return GNUNET_OK;
568 }
569
570
571 /**
572  * Begin monitoring sessions of a plugin.  There can only
573  * be one active monitor per plugin (i.e. if there are
574  * multiple monitors, the transport service needs to
575  * multiplex the generated events over all of them).
576  *
577  * @param cls closure of the plugin
578  * @param sic callback to invoke, NULL to disable monitor;
579  *            plugin will being by iterating over all active
580  *            sessions immediately and then enter monitor mode
581  * @param sic_cls closure for @a sic
582  */
583 static void
584 udp_plugin_setup_monitor (void *cls,
585                           GNUNET_TRANSPORT_SessionInfoCallback sic,
586                           void *sic_cls)
587 {
588   struct Plugin *plugin = cls;
589
590   plugin->sic = sic;
591   plugin->sic_cls = sic_cls;
592   if (NULL != sic)
593   {
594     GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
595                                            &send_session_info_iter,
596                                            plugin);
597     /* signal end of first iteration */
598     sic (sic_cls,
599          NULL,
600          NULL);
601   }
602 }
603
604
605 /* ****************** Little Helpers ****************** */
606
607
608 /**
609  * Function to free last resources associated with a session.
610  *
611  * @param s session to free
612  */
613 static void
614 free_session (struct GNUNET_ATS_Session *s)
615 {
616   if (NULL != s->address)
617   {
618     GNUNET_HELLO_address_free (s->address);
619     s->address = NULL;
620   }
621   if (NULL != s->frag_ctx)
622   {
623     GNUNET_FRAGMENT_context_destroy (s->frag_ctx->frag,
624                                      NULL,
625                                      NULL);
626     GNUNET_free (s->frag_ctx);
627     s->frag_ctx = NULL;
628   }
629   GNUNET_free (s);
630 }
631
632
633 /**
634  * Function that is called to get the keepalive factor.
635  * #GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
636  * calculate the interval between keepalive packets.
637  *
638  * @param cls closure with the `struct Plugin`
639  * @return keepalive factor
640  */
641 static unsigned int
642 udp_query_keepalive_factor (void *cls)
643 {
644   return 15;
645 }
646
647
648 /**
649  * Function obtain the network type for a session
650  *
651  * @param cls closure (`struct Plugin *`)
652  * @param session the session
653  * @return the network type
654  */
655 static enum GNUNET_ATS_Network_Type
656 udp_plugin_get_network (void *cls,
657                         struct GNUNET_ATS_Session *session)
658 {
659   return session->scope;
660 }
661
662
663 /**
664  * Function obtain the network type for an address.
665  *
666  * @param cls closure (`struct Plugin *`)
667  * @param address the address
668  * @return the network type
669  */
670 static enum GNUNET_ATS_Network_Type
671 udp_plugin_get_network_for_address (void *cls,
672                                     const struct GNUNET_HELLO_Address *address)
673 {
674   struct Plugin *plugin = cls;
675   size_t addrlen;
676   struct sockaddr_in a4;
677   struct sockaddr_in6 a6;
678   const struct IPv4UdpAddress *u4;
679   const struct IPv6UdpAddress *u6;
680   const void *sb;
681   size_t sbs;
682
683   addrlen = address->address_length;
684   if (addrlen == sizeof(struct IPv6UdpAddress))
685   {
686     GNUNET_assert (NULL != address->address); /* make static analysis happy */
687     u6 = address->address;
688     memset (&a6, 0, sizeof(a6));
689 #if HAVE_SOCKADDR_IN_SIN_LEN
690     a6.sin6_len = sizeof (a6);
691 #endif
692     a6.sin6_family = AF_INET6;
693     a6.sin6_port = u6->u6_port;
694     memcpy (&a6.sin6_addr, &u6->ipv6_addr, sizeof(struct in6_addr));
695     sb = &a6;
696     sbs = sizeof(a6);
697   }
698   else if (addrlen == sizeof(struct IPv4UdpAddress))
699   {
700     GNUNET_assert (NULL != address->address); /* make static analysis happy */
701     u4 = address->address;
702     memset (&a4, 0, sizeof(a4));
703 #if HAVE_SOCKADDR_IN_SIN_LEN
704     a4.sin_len = sizeof (a4);
705 #endif
706     a4.sin_family = AF_INET;
707     a4.sin_port = u4->u4_port;
708     a4.sin_addr.s_addr = u4->ipv4_addr;
709     sb = &a4;
710     sbs = sizeof(a4);
711   }
712   else
713   {
714     GNUNET_break (0);
715     return GNUNET_ATS_NET_UNSPECIFIED;
716   }
717   return plugin->env->get_address_type (plugin->env->cls,
718                                         sb,
719                                         sbs);
720 }
721
722
723 /* ******************* Event loop ******************** */
724
725 /**
726  * We have been notified that our readset has something to read.  We don't
727  * know which socket needs to be read, so we have to check each one
728  * Then reschedule this function to be called again once more is available.
729  *
730  * @param cls the plugin handle
731  * @param tc the scheduling context (for rescheduling this function again)
732  */
733 static void
734 udp_plugin_select_v4 (void *cls,
735                       const struct GNUNET_SCHEDULER_TaskContext *tc);
736
737
738 /**
739  * We have been notified that our readset has something to read.  We don't
740  * know which socket needs to be read, so we have to check each one
741  * Then reschedule this function to be called again once more is available.
742  *
743  * @param cls the plugin handle
744  * @param tc the scheduling context (for rescheduling this function again)
745  */
746 static void
747 udp_plugin_select_v6 (void *cls,
748                       const struct GNUNET_SCHEDULER_TaskContext *tc);
749
750
751 /**
752  * (re)schedule IPv4-select tasks for this plugin.
753  *
754  * @param plugin plugin to reschedule
755  */
756 static void
757 schedule_select_v4 (struct Plugin *plugin)
758 {
759   struct GNUNET_TIME_Relative min_delay;
760   struct GNUNET_TIME_Relative delay;
761   struct UDP_MessageWrapper *udpw;
762   struct UDP_MessageWrapper *min_udpw;
763
764   if ( (GNUNET_YES == plugin->enable_ipv4) &&
765        (NULL != plugin->sockv4) )
766   {
767     /* Find a message ready to send:
768      * Flow delay from other peer is expired or not set (0) */
769     min_delay = GNUNET_TIME_UNIT_FOREVER_REL;
770     min_udpw = NULL;
771     for (udpw = plugin->ipv4_queue_head; NULL != udpw; udpw = udpw->next)
772     {
773       delay = GNUNET_TIME_absolute_get_remaining (udpw->transmission_time);
774       if (delay.rel_value_us < min_delay.rel_value_us)
775       {
776         min_delay = delay;
777         min_udpw = udpw;
778       }
779     }
780     if (NULL != plugin->select_task_v4)
781       GNUNET_SCHEDULER_cancel (plugin->select_task_v4);
782     if (NULL != min_udpw)
783     {
784       if (min_delay.rel_value_us > GNUNET_CONSTANTS_LATENCY_WARN.rel_value_us)
785       {
786         GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
787                     "Calculated flow delay for UDPv4 at %s for %s\n",
788                     GNUNET_STRINGS_relative_time_to_string (min_delay,
789                                                             GNUNET_YES),
790                     GNUNET_i2s (&udpw->session->target));
791       }
792       else
793       {
794         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
795                     "Calculated flow delay for UDPv4 at %s for %s\n",
796                     GNUNET_STRINGS_relative_time_to_string (min_delay,
797                                                             GNUNET_YES),
798                     GNUNET_i2s (&udpw->session->target));
799       }
800     }
801     plugin->select_task_v4
802       = GNUNET_SCHEDULER_add_read_net (min_delay,
803                                        plugin->sockv4,
804                                        &udp_plugin_select_v4,
805                                        plugin);
806   }
807 }
808
809
810 /**
811  * (re)schedule IPv6-select tasks for this plugin.
812  *
813  * @param plugin plugin to reschedule
814  */
815 static void
816 schedule_select_v6 (struct Plugin *plugin)
817 {
818   struct GNUNET_TIME_Relative min_delay;
819   struct GNUNET_TIME_Relative delay;
820   struct UDP_MessageWrapper *udpw;
821   struct UDP_MessageWrapper *min_udpw;
822
823   if ( (GNUNET_YES == plugin->enable_ipv6) &&
824        (NULL != plugin->sockv6) )
825   {
826     min_delay = GNUNET_TIME_UNIT_FOREVER_REL;
827     min_udpw = NULL;
828     for (udpw = plugin->ipv6_queue_head; NULL != udpw; udpw = udpw->next)
829     {
830       delay = GNUNET_TIME_absolute_get_remaining (udpw->transmission_time);
831       if (delay.rel_value_us < min_delay.rel_value_us)
832       {
833         min_delay = delay;
834         min_udpw = udpw;
835       }
836     }
837     if (NULL != plugin->select_task_v6)
838       GNUNET_SCHEDULER_cancel (plugin->select_task_v6);
839     if (NULL != min_udpw)
840     {
841       if (min_delay.rel_value_us > GNUNET_CONSTANTS_LATENCY_WARN.rel_value_us)
842       {
843         GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
844                     "Calculated flow delay for UDPv6 at %s for %s\n",
845                     GNUNET_STRINGS_relative_time_to_string (min_delay,
846                                                             GNUNET_YES),
847                     GNUNET_i2s (&udpw->session->target));
848       }
849       else
850       {
851         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
852                     "Calculated flow delay for UDPv6 at %s for %s\n",
853                     GNUNET_STRINGS_relative_time_to_string (min_delay,
854                                                             GNUNET_YES),
855                     GNUNET_i2s (&udpw->session->target));
856       }
857     }
858     plugin->select_task_v6
859       = GNUNET_SCHEDULER_add_read_net (min_delay,
860                                        plugin->sockv6,
861                                        &udp_plugin_select_v6,
862                                        plugin);
863   }
864 }
865
866
867 /* ******************* Address to string and back ***************** */
868
869
870 /**
871  * Function called for a quick conversion of the binary address to
872  * a numeric address.  Note that the caller must not free the
873  * address and that the next call to this function is allowed
874  * to override the address again.
875  *
876  * @param cls closure
877  * @param addr binary address (a `union UdpAddress`)
878  * @param addrlen length of the @a addr
879  * @return string representing the same address
880  */
881 const char *
882 udp_address_to_string (void *cls,
883                        const void *addr,
884                        size_t addrlen)
885 {
886   static char rbuf[INET6_ADDRSTRLEN + 10];
887   char buf[INET6_ADDRSTRLEN];
888   const void *sb;
889   struct in_addr a4;
890   struct in6_addr a6;
891   const struct IPv4UdpAddress *t4;
892   const struct IPv6UdpAddress *t6;
893   int af;
894   uint16_t port;
895   uint32_t options;
896
897   if (NULL == addr)
898   {
899     GNUNET_break_op (0);
900     return NULL;
901   }
902
903   if (addrlen == sizeof(struct IPv6UdpAddress))
904   {
905     t6 = addr;
906     af = AF_INET6;
907     options = ntohl (t6->options);
908     port = ntohs (t6->u6_port);
909     a6 = t6->ipv6_addr;
910     sb = &a6;
911   }
912   else if (addrlen == sizeof(struct IPv4UdpAddress))
913   {
914     t4 = addr;
915     af = AF_INET;
916     options = ntohl (t4->options);
917     port = ntohs (t4->u4_port);
918     a4.s_addr = t4->ipv4_addr;
919     sb = &a4;
920   }
921   else
922   {
923     GNUNET_break_op (0);
924     return NULL;
925   }
926   inet_ntop (af,
927              sb,
928              buf,
929              INET6_ADDRSTRLEN);
930   GNUNET_snprintf (rbuf,
931                    sizeof(rbuf),
932                    (af == AF_INET6)
933                    ? "%s.%u.[%s]:%u"
934                    : "%s.%u.%s:%u",
935                    PLUGIN_NAME,
936                    options,
937                    buf,
938                    port);
939   return rbuf;
940 }
941
942
943 /**
944  * Function called to convert a string address to a binary address.
945  *
946  * @param cls closure (`struct Plugin *`)
947  * @param addr string address
948  * @param addrlen length of the address
949  * @param buf location to store the buffer
950  * @param added location to store the number of bytes in the buffer.
951  *        If the function returns #GNUNET_SYSERR, its contents are undefined.
952  * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
953  */
954 static int
955 udp_string_to_address (void *cls,
956                        const char *addr,
957                        uint16_t addrlen,
958                        void **buf,
959                        size_t *added)
960 {
961   struct sockaddr_storage socket_address;
962   char *address;
963   char *plugin;
964   char *optionstr;
965   uint32_t options;
966
967   /* Format tcp.options.address:port */
968   address = NULL;
969   plugin = NULL;
970   optionstr = NULL;
971
972   if ((NULL == addr) || (0 == addrlen))
973   {
974     GNUNET_break (0);
975     return GNUNET_SYSERR;
976   }
977   if ('\0' != addr[addrlen - 1])
978   {
979     GNUNET_break (0);
980     return GNUNET_SYSERR;
981   }
982   if (strlen (addr) != addrlen - 1)
983   {
984     GNUNET_break (0);
985     return GNUNET_SYSERR;
986   }
987   plugin = GNUNET_strdup (addr);
988   optionstr = strchr (plugin, '.');
989   if (NULL == optionstr)
990   {
991     GNUNET_break (0);
992     GNUNET_free (plugin);
993     return GNUNET_SYSERR;
994   }
995   optionstr[0] = '\0';
996   optionstr++;
997   options = atol (optionstr);
998   address = strchr (optionstr, '.');
999   if (NULL == address)
1000   {
1001     GNUNET_break (0);
1002     GNUNET_free (plugin);
1003     return GNUNET_SYSERR;
1004   }
1005   address[0] = '\0';
1006   address++;
1007
1008   if (GNUNET_OK !=
1009       GNUNET_STRINGS_to_address_ip (address,
1010                                     strlen (address),
1011                                     &socket_address))
1012   {
1013     GNUNET_break (0);
1014     GNUNET_free (plugin);
1015     return GNUNET_SYSERR;
1016   }
1017   GNUNET_free(plugin);
1018
1019   switch (socket_address.ss_family)
1020   {
1021   case AF_INET:
1022     {
1023       struct IPv4UdpAddress *u4;
1024       const struct sockaddr_in *in4 = (const struct sockaddr_in *) &socket_address;
1025
1026       u4 = GNUNET_new (struct IPv4UdpAddress);
1027       u4->options = htonl (options);
1028       u4->ipv4_addr = in4->sin_addr.s_addr;
1029       u4->u4_port = in4->sin_port;
1030       *buf = u4;
1031       *added = sizeof (struct IPv4UdpAddress);
1032       return GNUNET_OK;
1033     }
1034   case AF_INET6:
1035     {
1036       struct IPv6UdpAddress *u6;
1037       const struct sockaddr_in6 *in6 = (const struct sockaddr_in6 *) &socket_address;
1038
1039       u6 = GNUNET_new (struct IPv6UdpAddress);
1040       u6->options = htonl (options);
1041       u6->ipv6_addr = in6->sin6_addr;
1042       u6->u6_port = in6->sin6_port;
1043       *buf = u6;
1044       *added = sizeof (struct IPv6UdpAddress);
1045       return GNUNET_OK;
1046     }
1047   default:
1048     GNUNET_break (0);
1049     return GNUNET_SYSERR;
1050   }
1051 }
1052
1053
1054 /**
1055  * Append our port and forward the result.
1056  *
1057  * @param cls a `struct PrettyPrinterContext *`
1058  * @param hostname result from DNS resolver
1059  */
1060 static void
1061 append_port (void *cls,
1062              const char *hostname)
1063 {
1064   struct PrettyPrinterContext *ppc = cls;
1065   struct Plugin *plugin = ppc->plugin;
1066   char *ret;
1067
1068   if (NULL == hostname)
1069   {
1070     /* Final call, done */
1071     GNUNET_CONTAINER_DLL_remove (plugin->ppc_dll_head,
1072                                  plugin->ppc_dll_tail,
1073                                  ppc);
1074     ppc->resolver_handle = NULL;
1075     ppc->asc (ppc->asc_cls,
1076               NULL,
1077               GNUNET_OK);
1078     GNUNET_free (ppc);
1079     return;
1080   }
1081   if (GNUNET_YES == ppc->ipv6)
1082     GNUNET_asprintf (&ret,
1083                      "%s.%u.[%s]:%d",
1084                      PLUGIN_NAME,
1085                      ppc->options,
1086                      hostname,
1087                      ppc->port);
1088   else
1089     GNUNET_asprintf (&ret,
1090                      "%s.%u.%s:%d",
1091                      PLUGIN_NAME,
1092                      ppc->options,
1093                      hostname,
1094                      ppc->port);
1095   ppc->asc (ppc->asc_cls,
1096             ret,
1097             GNUNET_OK);
1098   GNUNET_free (ret);
1099 }
1100
1101
1102 /**
1103  * Convert the transports address to a nice, human-readable format.
1104  *
1105  * @param cls closure with the `struct Plugin *`
1106  * @param type name of the transport that generated the address
1107  * @param addr one of the addresses of the host, NULL for the last address
1108  *        the specific address format depends on the transport;
1109  *        a `union UdpAddress`
1110  * @param addrlen length of the address
1111  * @param numeric should (IP) addresses be displayed in numeric form?
1112  * @param timeout after how long should we give up?
1113  * @param asc function to call on each string
1114  * @param asc_cls closure for @a asc
1115  */
1116 static void
1117 udp_plugin_address_pretty_printer (void *cls,
1118                                    const char *type,
1119                                    const void *addr,
1120                                    size_t addrlen,
1121                                    int numeric,
1122                                    struct GNUNET_TIME_Relative timeout,
1123                                    GNUNET_TRANSPORT_AddressStringCallback asc,
1124                                    void *asc_cls)
1125 {
1126   struct Plugin *plugin = cls;
1127   struct PrettyPrinterContext *ppc;
1128   const struct sockaddr *sb;
1129   size_t sbs;
1130   struct sockaddr_in a4;
1131   struct sockaddr_in6 a6;
1132   const struct IPv4UdpAddress *u4;
1133   const struct IPv6UdpAddress *u6;
1134   uint16_t port;
1135   uint32_t options;
1136
1137   if (addrlen == sizeof(struct IPv6UdpAddress))
1138   {
1139     u6 = addr;
1140     memset (&a6,
1141             0,
1142             sizeof (a6));
1143     a6.sin6_family = AF_INET6;
1144 #if HAVE_SOCKADDR_IN_SIN_LEN
1145     a6.sin6_len = sizeof (a6);
1146 #endif
1147     a6.sin6_port = u6->u6_port;
1148     a6.sin6_addr = u6->ipv6_addr;
1149     port = ntohs (u6->u6_port);
1150     options = ntohl (u6->options);
1151     sb = (const struct sockaddr *) &a6;
1152     sbs = sizeof (a6);
1153   }
1154   else if (addrlen == sizeof (struct IPv4UdpAddress))
1155   {
1156     u4 = addr;
1157     memset (&a4,
1158             0,
1159             sizeof(a4));
1160     a4.sin_family = AF_INET;
1161 #if HAVE_SOCKADDR_IN_SIN_LEN
1162     a4.sin_len = sizeof (a4);
1163 #endif
1164     a4.sin_port = u4->u4_port;
1165     a4.sin_addr.s_addr = u4->ipv4_addr;
1166     port = ntohs (u4->u4_port);
1167     options = ntohl (u4->options);
1168     sb = (const struct sockaddr *) &a4;
1169     sbs = sizeof(a4);
1170   }
1171   else
1172   {
1173     /* invalid address */
1174     GNUNET_break_op (0);
1175     asc (asc_cls,
1176          NULL,
1177          GNUNET_SYSERR);
1178     asc (asc_cls,
1179          NULL,
1180          GNUNET_OK);
1181     return;
1182   }
1183   ppc = GNUNET_new (struct PrettyPrinterContext);
1184   ppc->plugin = plugin;
1185   ppc->asc = asc;
1186   ppc->asc_cls = asc_cls;
1187   ppc->port = port;
1188   ppc->options = options;
1189   if (addrlen == sizeof (struct IPv6UdpAddress))
1190     ppc->ipv6 = GNUNET_YES;
1191   else
1192     ppc->ipv6 = GNUNET_NO;
1193   GNUNET_CONTAINER_DLL_insert (plugin->ppc_dll_head,
1194                                plugin->ppc_dll_tail,
1195                                ppc);
1196   ppc->resolver_handle
1197     = GNUNET_RESOLVER_hostname_get (sb,
1198                                     sbs,
1199                                     ! numeric,
1200                                     timeout,
1201                                     &append_port,
1202                                     ppc);
1203 }
1204
1205
1206 /**
1207  * Check if the given port is plausible (must be either our listen
1208  * port or our advertised port).  If it is neither, we return
1209  * #GNUNET_SYSERR.
1210  *
1211  * @param plugin global variables
1212  * @param in_port port number to check
1213  * @return #GNUNET_OK if port is either our open or advertised port
1214  */
1215 static int
1216 check_port (const struct Plugin *plugin,
1217             uint16_t in_port)
1218 {
1219   if ( (plugin->port == in_port) ||
1220        (plugin->aport == in_port) )
1221     return GNUNET_OK;
1222   return GNUNET_SYSERR;
1223 }
1224
1225
1226 /**
1227  * Function that will be called to check if a binary address for this
1228  * plugin is well-formed and corresponds to an address for THIS peer
1229  * (as per our configuration).  Naturally, if absolutely necessary,
1230  * plugins can be a bit conservative in their answer, but in general
1231  * plugins should make sure that the address does not redirect
1232  * traffic to a 3rd party that might try to man-in-the-middle our
1233  * traffic.
1234  *
1235  * @param cls closure, should be our handle to the Plugin
1236  * @param addr pointer to a `union UdpAddress`
1237  * @param addrlen length of @a addr
1238  * @return #GNUNET_OK if this is a plausible address for this peer
1239  *         and transport, #GNUNET_SYSERR if not
1240  */
1241 static int
1242 udp_plugin_check_address (void *cls,
1243                           const void *addr,
1244                           size_t addrlen)
1245 {
1246   struct Plugin *plugin = cls;
1247   const struct IPv4UdpAddress *v4;
1248   const struct IPv6UdpAddress *v6;
1249
1250   if (sizeof(struct IPv4UdpAddress) == addrlen)
1251   {
1252     v4 = (const struct IPv4UdpAddress *) addr;
1253     if (GNUNET_OK != check_port (plugin,
1254                                  ntohs (v4->u4_port)))
1255       return GNUNET_SYSERR;
1256     if (GNUNET_OK !=
1257         GNUNET_NAT_test_address (plugin->nat,
1258                                  &v4->ipv4_addr,
1259                                  sizeof (struct in_addr)))
1260       return GNUNET_SYSERR;
1261   }
1262   else if (sizeof(struct IPv6UdpAddress) == addrlen)
1263   {
1264     v6 = (const struct IPv6UdpAddress *) addr;
1265     if (IN6_IS_ADDR_LINKLOCAL (&v6->ipv6_addr))
1266     {
1267       GNUNET_break_op (0);
1268       return GNUNET_SYSERR;
1269     }
1270     if (GNUNET_OK != check_port (plugin,
1271                                  ntohs (v6->u6_port)))
1272       return GNUNET_SYSERR;
1273     if (GNUNET_OK !=
1274         GNUNET_NAT_test_address (plugin->nat,
1275                                  &v6->ipv6_addr,
1276                                  sizeof (struct in6_addr)))
1277       return GNUNET_SYSERR;
1278   }
1279   else
1280   {
1281     GNUNET_break_op (0);
1282     return GNUNET_SYSERR;
1283   }
1284   return GNUNET_OK;
1285 }
1286
1287
1288 /**
1289  * Our external IP address/port mapping has changed.
1290  *
1291  * @param cls closure, the `struct Plugin`
1292  * @param add_remove #GNUNET_YES to mean the new public IP address,
1293  *                   #GNUNET_NO to mean the previous (now invalid) one
1294  * @param addr either the previous or the new public IP address
1295  * @param addrlen actual length of the @a addr
1296  */
1297 static void
1298 udp_nat_port_map_callback (void *cls,
1299                            int add_remove,
1300                            const struct sockaddr *addr,
1301                            socklen_t addrlen)
1302 {
1303   struct Plugin *plugin = cls;
1304   struct GNUNET_HELLO_Address *address;
1305   struct IPv4UdpAddress u4;
1306   struct IPv6UdpAddress u6;
1307   void *arg;
1308   size_t args;
1309
1310   LOG (GNUNET_ERROR_TYPE_DEBUG,
1311        (GNUNET_YES == add_remove)
1312        ? "NAT notification to add address `%s'\n"
1313        : "NAT notification to remove address `%s'\n",
1314        GNUNET_a2s (addr,
1315                    addrlen));
1316   /* convert 'address' to our internal format */
1317   switch (addr->sa_family)
1318   {
1319   case AF_INET:
1320     {
1321       const struct sockaddr_in *i4;
1322
1323       GNUNET_assert (sizeof(struct sockaddr_in) == addrlen);
1324       i4 = (const struct sockaddr_in *) addr;
1325       if (0 == ntohs (i4->sin_port))
1326       {
1327         GNUNET_break (0);
1328         return;
1329       }
1330       memset (&u4,
1331               0,
1332               sizeof(u4));
1333       u4.options = htonl (plugin->myoptions);
1334       u4.ipv4_addr = i4->sin_addr.s_addr;
1335       u4.u4_port = i4->sin_port;
1336       arg = &u4;
1337       args = sizeof (struct IPv4UdpAddress);
1338       break;
1339     }
1340   case AF_INET6:
1341     {
1342       const struct sockaddr_in6 *i6;
1343
1344       GNUNET_assert (sizeof(struct sockaddr_in6) == addrlen);
1345       i6 = (const struct sockaddr_in6 *) addr;
1346       if (0 == ntohs (i6->sin6_port))
1347       {
1348         GNUNET_break (0);
1349         return;
1350       }
1351       memset (&u6,
1352               0,
1353               sizeof(u6));
1354       u6.options = htonl (plugin->myoptions);
1355       u6.ipv6_addr = i6->sin6_addr;
1356       u6.u6_port = i6->sin6_port;
1357       arg = &u6;
1358       args = sizeof (struct IPv6UdpAddress);
1359       break;
1360     }
1361   default:
1362     GNUNET_break (0);
1363     return;
1364   }
1365   /* modify our published address list */
1366   address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
1367                                            PLUGIN_NAME,
1368                                            arg,
1369                                            args,
1370                                            GNUNET_HELLO_ADDRESS_INFO_NONE);
1371   plugin->env->notify_address (plugin->env->cls,
1372                                add_remove,
1373                                address);
1374   GNUNET_HELLO_address_free (address);
1375 }
1376
1377
1378 /* ********************* Finding sessions ******************* */
1379
1380
1381 /**
1382  * Closure for #session_cmp_it().
1383  */
1384 struct GNUNET_ATS_SessionCompareContext
1385 {
1386   /**
1387    * Set to session matching the address.
1388    */
1389   struct GNUNET_ATS_Session *res;
1390
1391   /**
1392    * Address we are looking for.
1393    */
1394   const struct GNUNET_HELLO_Address *address;
1395 };
1396
1397
1398 /**
1399  * Find a session with a matching address.
1400  *
1401  * @param cls the `struct GNUNET_ATS_SessionCompareContext *`
1402  * @param key peer identity (unused)
1403  * @param value the `struct GNUNET_ATS_Session *`
1404  * @return #GNUNET_NO if we found the session, #GNUNET_OK if not
1405  */
1406 static int
1407 session_cmp_it (void *cls,
1408                 const struct GNUNET_PeerIdentity *key,
1409                 void *value)
1410 {
1411   struct GNUNET_ATS_SessionCompareContext *cctx = cls;
1412   struct GNUNET_ATS_Session *s = value;
1413
1414   if (0 == GNUNET_HELLO_address_cmp (s->address,
1415                                      cctx->address))
1416   {
1417     GNUNET_assert (GNUNET_NO == s->in_destroy);
1418     cctx->res = s;
1419     return GNUNET_NO;
1420   }
1421   return GNUNET_OK;
1422 }
1423
1424
1425 /**
1426  * Locate an existing session the transport service is using to
1427  * send data to another peer.  Performs some basic sanity checks
1428  * on the address and then tries to locate a matching session.
1429  *
1430  * @param cls the plugin
1431  * @param address the address we should locate the session by
1432  * @return the session if it exists, or NULL if it is not found
1433  */
1434 static struct GNUNET_ATS_Session *
1435 udp_plugin_lookup_session (void *cls,
1436                            const struct GNUNET_HELLO_Address *address)
1437 {
1438   struct Plugin *plugin = cls;
1439   const struct IPv6UdpAddress *udp_a6;
1440   const struct IPv4UdpAddress *udp_a4;
1441   struct GNUNET_ATS_SessionCompareContext cctx;
1442
1443   if (NULL == address->address)
1444   {
1445     GNUNET_break (0);
1446     return NULL;
1447   }
1448   if (sizeof(struct IPv4UdpAddress) == address->address_length)
1449   {
1450     if (NULL == plugin->sockv4)
1451       return NULL;
1452     udp_a4 = (const struct IPv4UdpAddress *) address->address;
1453     if (0 == udp_a4->u4_port)
1454     {
1455       GNUNET_break (0);
1456       return NULL;
1457     }
1458   }
1459   else if (sizeof(struct IPv6UdpAddress) == address->address_length)
1460   {
1461     if (NULL == plugin->sockv6)
1462       return NULL;
1463     udp_a6 = (const struct IPv6UdpAddress *) address->address;
1464     if (0 == udp_a6->u6_port)
1465     {
1466       GNUNET_break (0);
1467       return NULL;
1468     }
1469   }
1470   else
1471   {
1472     GNUNET_break (0);
1473     return NULL;
1474   }
1475
1476   /* check if session already exists */
1477   cctx.address = address;
1478   cctx.res = NULL;
1479   LOG (GNUNET_ERROR_TYPE_DEBUG,
1480        "Looking for existing session for peer `%s' with address `%s'\n",
1481        GNUNET_i2s (&address->peer),
1482        udp_address_to_string (plugin,
1483                               address->address,
1484                               address->address_length));
1485   GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessions,
1486                                               &address->peer,
1487                                               &session_cmp_it,
1488                                               &cctx);
1489   if (NULL == cctx.res)
1490     return NULL;
1491   LOG (GNUNET_ERROR_TYPE_DEBUG,
1492        "Found existing session %p\n",
1493        cctx.res);
1494   return cctx.res;
1495 }
1496
1497
1498 /* ********************** Timeout ****************** */
1499
1500
1501 /**
1502  * Increment session timeout due to activity.
1503  *
1504  * @param s session to reschedule timeout activity for
1505  */
1506 static void
1507 reschedule_session_timeout (struct GNUNET_ATS_Session *s)
1508 {
1509   if (GNUNET_YES == s->in_destroy)
1510     return;
1511   GNUNET_assert (NULL != s->timeout_task);
1512   s->timeout = GNUNET_TIME_relative_to_absolute (UDP_SESSION_TIME_OUT);
1513 }
1514
1515
1516
1517 /**
1518  * Function that will be called whenever the transport service wants to
1519  * notify the plugin that a session is still active and in use and
1520  * therefore the session timeout for this session has to be updated
1521  *
1522  * @param cls closure with the `struct Plugin`
1523  * @param peer which peer was the session for
1524  * @param session which session is being updated
1525  */
1526 static void
1527 udp_plugin_update_session_timeout (void *cls,
1528                                    const struct GNUNET_PeerIdentity *peer,
1529                                    struct GNUNET_ATS_Session *session)
1530 {
1531   struct Plugin *plugin = cls;
1532
1533   if (GNUNET_YES !=
1534       GNUNET_CONTAINER_multipeermap_contains_value (plugin->sessions,
1535                                                     peer,
1536                                                     session))
1537   {
1538     GNUNET_break (0);
1539     return;
1540   }
1541   /* Reschedule session timeout */
1542   reschedule_session_timeout (session);
1543 }
1544
1545
1546 /* ************************* Sending ************************ */
1547
1548
1549 /**
1550  * Remove the given message from the transmission queue and
1551  * update all applicable statistics.
1552  *
1553  * @param plugin the UDP plugin
1554  * @param udpw message wrapper to dequeue
1555  */
1556 static void
1557 dequeue (struct Plugin *plugin,
1558          struct UDP_MessageWrapper *udpw)
1559 {
1560   struct GNUNET_ATS_Session *session = udpw->session;
1561
1562   if (plugin->bytes_in_buffer < udpw->msg_size)
1563   {
1564     GNUNET_break (0);
1565   }
1566   else
1567   {
1568     GNUNET_STATISTICS_update (plugin->env->stats,
1569                               "# UDP, total bytes in send buffers",
1570                               - (long long) udpw->msg_size,
1571                               GNUNET_NO);
1572     plugin->bytes_in_buffer -= udpw->msg_size;
1573   }
1574   GNUNET_STATISTICS_update (plugin->env->stats,
1575                             "# UDP, total messages in send buffers",
1576                             -1,
1577                             GNUNET_NO);
1578   if (sizeof(struct IPv4UdpAddress) == udpw->session->address->address_length)
1579   {
1580     GNUNET_CONTAINER_DLL_remove (plugin->ipv4_queue_head,
1581                                  plugin->ipv4_queue_tail,
1582                                  udpw);
1583   }
1584   else if (sizeof(struct IPv6UdpAddress) == udpw->session->address->address_length)
1585   {
1586     GNUNET_CONTAINER_DLL_remove (plugin->ipv6_queue_head,
1587                                  plugin->ipv6_queue_tail,
1588                                  udpw);
1589   }
1590   else
1591   {
1592     GNUNET_break (0);
1593     return;
1594   }
1595   GNUNET_assert (session->msgs_in_queue > 0);
1596   session->msgs_in_queue--;
1597   GNUNET_assert (session->bytes_in_queue >= udpw->msg_size);
1598   session->bytes_in_queue -= udpw->msg_size;
1599 }
1600
1601
1602 /**
1603  * Enqueue a message for transmission and update statistics.
1604  *
1605  * @param plugin the UDP plugin
1606  * @param udpw message wrapper to queue
1607  */
1608 static void
1609 enqueue (struct Plugin *plugin,
1610          struct UDP_MessageWrapper *udpw)
1611 {
1612   struct GNUNET_ATS_Session *session = udpw->session;
1613
1614   if (GNUNET_YES == session->in_destroy)
1615   {
1616     GNUNET_break (0);
1617     return;
1618   }
1619   if (plugin->bytes_in_buffer + udpw->msg_size > INT64_MAX)
1620   {
1621     GNUNET_break (0);
1622   }
1623   else
1624   {
1625     GNUNET_STATISTICS_update (plugin->env->stats,
1626                               "# UDP, total bytes in send buffers",
1627                               udpw->msg_size,
1628                               GNUNET_NO);
1629     plugin->bytes_in_buffer += udpw->msg_size;
1630   }
1631   GNUNET_STATISTICS_update (plugin->env->stats,
1632                             "# UDP, total messages in send buffers",
1633                             1,
1634                             GNUNET_NO);
1635   if (sizeof (struct IPv4UdpAddress) == udpw->session->address->address_length)
1636   {
1637     GNUNET_CONTAINER_DLL_insert(plugin->ipv4_queue_head,
1638                                 plugin->ipv4_queue_tail,
1639                                 udpw);
1640   }
1641   else if (sizeof (struct IPv6UdpAddress) == udpw->session->address->address_length)
1642   {
1643     GNUNET_CONTAINER_DLL_insert (plugin->ipv6_queue_head,
1644                                  plugin->ipv6_queue_tail,
1645                                  udpw);
1646   }
1647   else
1648   {
1649     GNUNET_break (0);
1650     udpw->cont (udpw->cont_cls,
1651                 &session->target,
1652                 GNUNET_SYSERR,
1653                 udpw->msg_size,
1654                 0);
1655     GNUNET_free (udpw);
1656     return;
1657   }
1658   session->msgs_in_queue++;
1659   session->bytes_in_queue += udpw->msg_size;
1660 }
1661
1662
1663 /**
1664  * We have completed our (attempt) to transmit a message that had to
1665  * be fragmented -- either because we got an ACK saying that all
1666  * fragments were received, or because of timeout / disconnect.  Clean
1667  * up our state.
1668  *
1669  * @param frag_ctx fragmentation context to clean up
1670  * @param result #GNUNET_OK if we succeeded (got ACK),
1671  *               #GNUNET_SYSERR if the transmission failed
1672  */
1673 static void
1674 fragmented_message_done (struct UDP_FragmentationContext *frag_ctx,
1675                          int result)
1676 {
1677   struct Plugin *plugin = frag_ctx->plugin;
1678   struct GNUNET_ATS_Session *s = frag_ctx->session;
1679   struct UDP_MessageWrapper *udpw;
1680   struct UDP_MessageWrapper *tmp;
1681   size_t overhead;
1682   struct GNUNET_TIME_Relative delay;
1683
1684   LOG (GNUNET_ERROR_TYPE_DEBUG,
1685        "%p: Fragmented message removed with result %s\n",
1686        frag_ctx,
1687        (result == GNUNET_SYSERR) ? "FAIL" : "SUCCESS");
1688   /* Call continuation for fragmented message */
1689   if (frag_ctx->on_wire_size >= frag_ctx->payload_size)
1690     overhead = frag_ctx->on_wire_size - frag_ctx->payload_size;
1691   else
1692     overhead = frag_ctx->on_wire_size;
1693   delay = GNUNET_TIME_absolute_get_duration (frag_ctx->start_time);
1694   if (delay.rel_value_us > GNUNET_CONSTANTS_LATENCY_WARN.rel_value_us)
1695   {
1696     LOG (GNUNET_ERROR_TYPE_WARNING,
1697          "Fragmented message acknowledged after %s\n",
1698          GNUNET_STRINGS_relative_time_to_string (delay,
1699                                                  GNUNET_YES));
1700   }
1701   else
1702   {
1703     LOG (GNUNET_ERROR_TYPE_DEBUG,
1704          "Fragmented message acknowledged after %s\n",
1705          GNUNET_STRINGS_relative_time_to_string (delay,
1706                                                  GNUNET_YES));
1707   }
1708
1709   if (NULL != frag_ctx->cont)
1710     frag_ctx->cont (frag_ctx->cont_cls,
1711                     &s->target,
1712                     result,
1713                     s->frag_ctx->payload_size,
1714                     frag_ctx->on_wire_size);
1715   GNUNET_STATISTICS_update (plugin->env->stats,
1716                             "# UDP, fragmented messages active",
1717                             -1,
1718                             GNUNET_NO);
1719
1720   if (GNUNET_OK == result)
1721   {
1722     GNUNET_STATISTICS_update (plugin->env->stats,
1723                               "# UDP, fragmented msgs, messages, sent, success",
1724                               1,
1725                               GNUNET_NO);
1726     GNUNET_STATISTICS_update (plugin->env->stats,
1727                               "# UDP, fragmented msgs, bytes payload, sent, success",
1728                               s->frag_ctx->payload_size,
1729                               GNUNET_NO);
1730     GNUNET_STATISTICS_update (plugin->env->stats,
1731                               "# UDP, fragmented msgs, bytes overhead, sent, success",
1732                               overhead,
1733                               GNUNET_NO);
1734     GNUNET_STATISTICS_update (plugin->env->stats,
1735                               "# UDP, total, bytes overhead, sent",
1736                               overhead,
1737                               GNUNET_NO);
1738     GNUNET_STATISTICS_update (plugin->env->stats,
1739                               "# UDP, total, bytes payload, sent",
1740                               s->frag_ctx->payload_size,
1741                               GNUNET_NO);
1742   }
1743   else
1744   {
1745     GNUNET_STATISTICS_update (plugin->env->stats,
1746                               "# UDP, fragmented msgs, messages, sent, failure",
1747                               1,
1748                               GNUNET_NO);
1749     GNUNET_STATISTICS_update (plugin->env->stats,
1750                               "# UDP, fragmented msgs, bytes payload, sent, failure",
1751                               s->frag_ctx->payload_size,
1752                               GNUNET_NO);
1753     GNUNET_STATISTICS_update (plugin->env->stats,
1754                               "# UDP, fragmented msgs, bytes payload, sent, failure",
1755                               overhead,
1756                               GNUNET_NO);
1757     GNUNET_STATISTICS_update (plugin->env->stats,
1758                               "# UDP, fragmented msgs, bytes payload, sent, failure",
1759                               overhead,
1760                               GNUNET_NO);
1761   }
1762
1763   /* Remove remaining fragments from queue, no need to transmit those
1764      any longer. */
1765   if (s->address->address_length == sizeof(struct IPv6UdpAddress))
1766   {
1767     udpw = plugin->ipv6_queue_head;
1768     while (NULL != udpw)
1769     {
1770       tmp = udpw->next;
1771       if ( (udpw->frag_ctx != NULL) &&
1772            (udpw->frag_ctx == frag_ctx) )
1773       {
1774         dequeue (plugin,
1775                  udpw);
1776         GNUNET_free (udpw);
1777       }
1778       udpw = tmp;
1779     }
1780   }
1781   if (s->address->address_length == sizeof(struct IPv4UdpAddress))
1782   {
1783     udpw = plugin->ipv4_queue_head;
1784     while (NULL != udpw)
1785     {
1786       tmp = udpw->next;
1787       if ( (NULL != udpw->frag_ctx) &&
1788            (udpw->frag_ctx == frag_ctx) )
1789       {
1790         dequeue (plugin,
1791                  udpw);
1792         GNUNET_free (udpw);
1793       }
1794       udpw = tmp;
1795     }
1796   }
1797   notify_session_monitor (s->plugin,
1798                           s,
1799                           GNUNET_TRANSPORT_SS_UPDATE);
1800   GNUNET_FRAGMENT_context_destroy (frag_ctx->frag,
1801                                    &s->last_expected_msg_delay,
1802                                    &s->last_expected_ack_delay);
1803   s->frag_ctx = NULL;
1804   GNUNET_free (frag_ctx);
1805 }
1806
1807
1808 /**
1809  * We are finished with a fragment in the message queue.
1810  * Notify the continuation and update statistics.
1811  *
1812  * @param cls the `struct Plugin *`
1813  * @param udpw the queue entry
1814  * @param result #GNUNET_OK on success, #GNUNET_SYSERR on failure
1815  */
1816 static void
1817 qc_fragment_sent (void *cls,
1818                   struct UDP_MessageWrapper *udpw,
1819                   int result)
1820 {
1821   struct Plugin *plugin = cls;
1822
1823   GNUNET_assert (NULL != udpw->frag_ctx);
1824   if (GNUNET_OK == result)
1825   {
1826     GNUNET_FRAGMENT_context_transmission_done (udpw->frag_ctx->frag);
1827     GNUNET_STATISTICS_update (plugin->env->stats,
1828                               "# UDP, fragmented msgs, fragments, sent, success",
1829                               1,
1830                               GNUNET_NO);
1831     GNUNET_STATISTICS_update (plugin->env->stats,
1832                               "# UDP, fragmented msgs, fragments bytes, sent, success",
1833                               udpw->msg_size,
1834                               GNUNET_NO);
1835   }
1836   else
1837   {
1838     fragmented_message_done (udpw->frag_ctx,
1839                              GNUNET_SYSERR);
1840     GNUNET_STATISTICS_update (plugin->env->stats,
1841                               "# UDP, fragmented msgs, fragments, sent, failure",
1842                               1,
1843                               GNUNET_NO);
1844     GNUNET_STATISTICS_update (plugin->env->stats,
1845                               "# UDP, fragmented msgs, fragments bytes, sent, failure",
1846                               udpw->msg_size,
1847                               GNUNET_NO);
1848   }
1849 }
1850
1851
1852 /**
1853  * Function that is called with messages created by the fragmentation
1854  * module.  In the case of the `proc` callback of the
1855  * #GNUNET_FRAGMENT_context_create() function, this function must
1856  * eventually call #GNUNET_FRAGMENT_context_transmission_done().
1857  *
1858  * @param cls closure, the `struct UDP_FragmentationContext`
1859  * @param msg the message that was created
1860  */
1861 static void
1862 enqueue_fragment (void *cls,
1863                   const struct GNUNET_MessageHeader *msg)
1864 {
1865   struct UDP_FragmentationContext *frag_ctx = cls;
1866   struct Plugin *plugin = frag_ctx->plugin;
1867   struct UDP_MessageWrapper *udpw;
1868   struct GNUNET_ATS_Session *session = frag_ctx->session;
1869   size_t msg_len = ntohs (msg->size);
1870
1871   LOG (GNUNET_ERROR_TYPE_DEBUG,
1872        "Enqueuing fragment with %u bytes\n",
1873        msg_len);
1874   udpw = GNUNET_malloc (sizeof (struct UDP_MessageWrapper) + msg_len);
1875   udpw->session = session;
1876   udpw->msg_buf = (char *) &udpw[1];
1877   udpw->msg_size = msg_len;
1878   udpw->payload_size = msg_len; /* FIXME: minus fragment overhead */
1879   udpw->timeout = frag_ctx->timeout;
1880   udpw->start_time = frag_ctx->start_time;
1881   udpw->transmission_time = frag_ctx->next_frag_time;
1882   frag_ctx->next_frag_time
1883     = GNUNET_TIME_absolute_add (frag_ctx->next_frag_time,
1884                                 frag_ctx->flow_delay_from_other_peer);
1885   udpw->frag_ctx = frag_ctx;
1886   udpw->qc = &qc_fragment_sent;
1887   udpw->qc_cls = plugin;
1888   memcpy (udpw->msg_buf,
1889           msg,
1890           msg_len);
1891   enqueue (plugin,
1892            udpw);
1893 }
1894
1895
1896 /**
1897  * We are finished with a message from the message queue.
1898  * Notify the continuation and update statistics.
1899  *
1900  * @param cls the `struct Plugin *`
1901  * @param udpw the queue entry
1902  * @param result #GNUNET_OK on success, #GNUNET_SYSERR on failure
1903  */
1904 static void
1905 qc_message_sent (void *cls,
1906                  struct UDP_MessageWrapper *udpw,
1907                  int result)
1908 {
1909   struct Plugin *plugin = cls;
1910   size_t overhead;
1911   struct GNUNET_TIME_Relative delay;
1912
1913   if (udpw->msg_size >= udpw->payload_size)
1914     overhead = udpw->msg_size - udpw->payload_size;
1915   else
1916     overhead = udpw->msg_size;
1917
1918   if (NULL != udpw->cont)
1919   {
1920     delay = GNUNET_TIME_absolute_get_duration (udpw->start_time);
1921     if (delay.rel_value_us > GNUNET_CONSTANTS_LATENCY_WARN.rel_value_us)
1922     {
1923       LOG (GNUNET_ERROR_TYPE_WARNING,
1924            "Message sent via UDP with delay of %s\n",
1925            GNUNET_STRINGS_relative_time_to_string (delay,
1926                                                    GNUNET_YES));
1927     }
1928     else
1929     {
1930       LOG (GNUNET_ERROR_TYPE_DEBUG,
1931            "Message sent via UDP with delay of %s\n",
1932            GNUNET_STRINGS_relative_time_to_string (delay,
1933                                                    GNUNET_YES));
1934     }
1935     udpw->cont (udpw->cont_cls,
1936                 &udpw->session->target,
1937                 result,
1938                 udpw->payload_size,
1939                 overhead);
1940   }
1941   if (GNUNET_OK == result)
1942   {
1943     GNUNET_STATISTICS_update (plugin->env->stats,
1944                               "# UDP, unfragmented msgs, messages, sent, success",
1945                               1,
1946                               GNUNET_NO);
1947     GNUNET_STATISTICS_update (plugin->env->stats,
1948                               "# UDP, unfragmented msgs, bytes payload, sent, success",
1949                               udpw->payload_size,
1950                               GNUNET_NO);
1951     GNUNET_STATISTICS_update (plugin->env->stats,
1952                               "# UDP, unfragmented msgs, bytes overhead, sent, success",
1953                               overhead,
1954                               GNUNET_NO);
1955     GNUNET_STATISTICS_update (plugin->env->stats,
1956                               "# UDP, total, bytes overhead, sent",
1957                               overhead,
1958                               GNUNET_NO);
1959     GNUNET_STATISTICS_update (plugin->env->stats,
1960                               "# UDP, total, bytes payload, sent",
1961                               udpw->payload_size,
1962                               GNUNET_NO);
1963   }
1964   else
1965   {
1966     GNUNET_STATISTICS_update (plugin->env->stats,
1967                               "# UDP, unfragmented msgs, messages, sent, failure",
1968                               1,
1969                               GNUNET_NO);
1970     GNUNET_STATISTICS_update (plugin->env->stats,
1971                               "# UDP, unfragmented msgs, bytes payload, sent, failure",
1972                               udpw->payload_size,
1973                               GNUNET_NO);
1974     GNUNET_STATISTICS_update (plugin->env->stats,
1975                               "# UDP, unfragmented msgs, bytes overhead, sent, failure",
1976                               overhead,
1977                               GNUNET_NO);
1978   }
1979 }
1980
1981
1982 /**
1983  * Function that can be used by the transport service to transmit a
1984  * message using the plugin.  Note that in the case of a peer
1985  * disconnecting, the continuation MUST be called prior to the
1986  * disconnect notification itself.  This function will be called with
1987  * this peer's HELLO message to initiate a fresh connection to another
1988  * peer.
1989  *
1990  * @param cls closure
1991  * @param s which session must be used
1992  * @param msgbuf the message to transmit
1993  * @param msgbuf_size number of bytes in @a msgbuf
1994  * @param priority how important is the message (most plugins will
1995  *                 ignore message priority and just FIFO)
1996  * @param to how long to wait at most for the transmission (does not
1997  *                require plugins to discard the message after the timeout,
1998  *                just advisory for the desired delay; most plugins will ignore
1999  *                this as well)
2000  * @param cont continuation to call once the message has
2001  *        been transmitted (or if the transport is ready
2002  *        for the next transmission call; or if the
2003  *        peer disconnected...); can be NULL
2004  * @param cont_cls closure for @a cont
2005  * @return number of bytes used (on the physical network, with overheads);
2006  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
2007  *         and does NOT mean that the message was not transmitted (DV)
2008  */
2009 static ssize_t
2010 udp_plugin_send (void *cls,
2011                  struct GNUNET_ATS_Session *s,
2012                  const char *msgbuf,
2013                  size_t msgbuf_size,
2014                  unsigned int priority,
2015                  struct GNUNET_TIME_Relative to,
2016                  GNUNET_TRANSPORT_TransmitContinuation cont,
2017                  void *cont_cls)
2018 {
2019   struct Plugin *plugin = cls;
2020   size_t udpmlen = msgbuf_size + sizeof(struct UDPMessage);
2021   struct UDP_FragmentationContext *frag_ctx;
2022   struct UDP_MessageWrapper *udpw;
2023   struct UDPMessage *udp;
2024   char mbuf[udpmlen] GNUNET_ALIGN;
2025
2026   if ( (sizeof(struct IPv6UdpAddress) == s->address->address_length) &&
2027        (NULL == plugin->sockv6) )
2028     return GNUNET_SYSERR;
2029   if ( (sizeof(struct IPv4UdpAddress) == s->address->address_length) &&
2030        (NULL == plugin->sockv4) )
2031     return GNUNET_SYSERR;
2032   if (udpmlen >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
2033   {
2034     GNUNET_break (0);
2035     return GNUNET_SYSERR;
2036   }
2037   if (GNUNET_YES !=
2038       GNUNET_CONTAINER_multipeermap_contains_value (plugin->sessions,
2039                                                     &s->target,
2040                                                     s))
2041   {
2042     GNUNET_break (0);
2043     return GNUNET_SYSERR;
2044   }
2045   LOG (GNUNET_ERROR_TYPE_DEBUG,
2046        "UDP transmits %u-byte message to `%s' using address `%s'\n",
2047        udpmlen,
2048        GNUNET_i2s (&s->target),
2049        udp_address_to_string (plugin,
2050                               s->address->address,
2051                               s->address->address_length));
2052
2053   udp = (struct UDPMessage *) mbuf;
2054   udp->header.size = htons (udpmlen);
2055   udp->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_MESSAGE);
2056   udp->reserved = htonl (0);
2057   udp->sender = *plugin->env->my_identity;
2058
2059   /* We do not update the session time out here!  Otherwise this
2060    * session will not timeout since we send keep alive before session
2061    * can timeout.
2062    *
2063    * For UDP we update session timeout only on receive, this will
2064    * cover keep alives, since remote peer will reply with keep alive
2065    * responses!
2066    */
2067   if (udpmlen <= UDP_MTU)
2068   {
2069     /* unfragmented message */
2070     udpw = GNUNET_malloc (sizeof (struct UDP_MessageWrapper) + udpmlen);
2071     udpw->session = s;
2072     udpw->msg_buf = (char *) &udpw[1];
2073     udpw->msg_size = udpmlen; /* message size with UDP overhead */
2074     udpw->payload_size = msgbuf_size; /* message size without UDP overhead */
2075     udpw->start_time = GNUNET_TIME_absolute_get ();
2076     udpw->timeout = GNUNET_TIME_relative_to_absolute (to);
2077     udpw->transmission_time = s->last_transmit_time;
2078     s->last_transmit_time
2079       = GNUNET_TIME_absolute_add (s->last_transmit_time,
2080                                   s->flow_delay_from_other_peer);
2081     udpw->cont = cont;
2082     udpw->cont_cls = cont_cls;
2083     udpw->frag_ctx = NULL;
2084     udpw->qc = &qc_message_sent;
2085     udpw->qc_cls = plugin;
2086     memcpy (udpw->msg_buf,
2087             udp,
2088             sizeof (struct UDPMessage));
2089     memcpy (&udpw->msg_buf[sizeof(struct UDPMessage)],
2090             msgbuf,
2091             msgbuf_size);
2092     enqueue (plugin,
2093              udpw);
2094     GNUNET_STATISTICS_update (plugin->env->stats,
2095                               "# UDP, unfragmented messages queued total",
2096                               1,
2097                               GNUNET_NO);
2098     GNUNET_STATISTICS_update (plugin->env->stats,
2099                               "# UDP, unfragmented bytes payload queued total",
2100                               msgbuf_size,
2101                               GNUNET_NO);
2102   }
2103   else
2104   {
2105     /* fragmented message */
2106     if (NULL != s->frag_ctx)
2107       return GNUNET_SYSERR;
2108     memcpy (&udp[1],
2109             msgbuf,
2110             msgbuf_size);
2111     frag_ctx = GNUNET_new (struct UDP_FragmentationContext);
2112     frag_ctx->plugin = plugin;
2113     frag_ctx->session = s;
2114     frag_ctx->cont = cont;
2115     frag_ctx->cont_cls = cont_cls;
2116     frag_ctx->start_time = GNUNET_TIME_absolute_get ();
2117     frag_ctx->next_frag_time = s->last_transmit_time;
2118     frag_ctx->flow_delay_from_other_peer
2119       = GNUNET_TIME_relative_divide (s->flow_delay_from_other_peer,
2120                                      1 + (msgbuf_size /
2121                                           UDP_MTU));
2122     frag_ctx->timeout = GNUNET_TIME_relative_to_absolute (to);
2123     frag_ctx->payload_size = msgbuf_size; /* unfragmented message size without UDP overhead */
2124     frag_ctx->on_wire_size = 0; /* bytes with UDP and fragmentation overhead */
2125     frag_ctx->frag = GNUNET_FRAGMENT_context_create (plugin->env->stats,
2126                                                      UDP_MTU,
2127                                                      &plugin->tracker,
2128                                                      s->last_expected_msg_delay,
2129                                                      s->last_expected_ack_delay,
2130                                                      &udp->header,
2131                                                      &enqueue_fragment,
2132                                                      frag_ctx);
2133     s->frag_ctx = frag_ctx;
2134     s->last_transmit_time = frag_ctx->next_frag_time;
2135     GNUNET_STATISTICS_update (plugin->env->stats,
2136                               "# UDP, fragmented messages active",
2137                               1,
2138                               GNUNET_NO);
2139     GNUNET_STATISTICS_update (plugin->env->stats,
2140                               "# UDP, fragmented messages, total",
2141                               1,
2142                               GNUNET_NO);
2143     GNUNET_STATISTICS_update (plugin->env->stats,
2144                               "# UDP, fragmented bytes (payload)",
2145                               frag_ctx->payload_size,
2146                               GNUNET_NO);
2147   }
2148   notify_session_monitor (s->plugin,
2149                           s,
2150                           GNUNET_TRANSPORT_SS_UPDATE);
2151   if (s->address->address_length == sizeof (struct IPv4UdpAddress))
2152     schedule_select_v4 (plugin);
2153   else
2154     schedule_select_v6 (plugin);
2155   return udpmlen;
2156 }
2157
2158
2159 /* ********************** Receiving ********************** */
2160
2161
2162 /**
2163  * Closure for #find_receive_context().
2164  */
2165 struct FindReceiveContext
2166 {
2167   /**
2168    * Where to store the result.
2169    */
2170   struct DefragContext *rc;
2171
2172   /**
2173    * Session associated with this context.
2174    */
2175   struct GNUNET_ATS_Session *session;
2176
2177   /**
2178    * Address to find.
2179    */
2180   const union UdpAddress *udp_addr;
2181
2182   /**
2183    * Number of bytes in @e udp_addr.
2184    */
2185   size_t udp_addr_len;
2186
2187 };
2188
2189
2190 /**
2191  * Scan the heap for a receive context with the given address.
2192  *
2193  * @param cls the `struct FindReceiveContext`
2194  * @param node internal node of the heap
2195  * @param element value stored at the node (a `struct ReceiveContext`)
2196  * @param cost cost associated with the node
2197  * @return #GNUNET_YES if we should continue to iterate,
2198  *         #GNUNET_NO if not.
2199  */
2200 static int
2201 find_receive_context (void *cls,
2202                       struct GNUNET_CONTAINER_HeapNode *node,
2203                       void *element,
2204                       GNUNET_CONTAINER_HeapCostType cost)
2205 {
2206   struct FindReceiveContext *frc = cls;
2207   struct DefragContext *e = element;
2208
2209   if ( (frc->udp_addr_len == e->udp_addr_len) &&
2210        (0 == memcmp (frc->udp_addr,
2211                      e->udp_addr,
2212                      frc->udp_addr_len)) )
2213   {
2214     frc->rc = e;
2215     return GNUNET_NO;
2216   }
2217   return GNUNET_YES;
2218 }
2219
2220
2221 /**
2222  * Functions with this signature are called whenever we need to close
2223  * a session due to a disconnect or failure to establish a connection.
2224  *
2225  * @param cls closure with the `struct Plugin`
2226  * @param s session to close down
2227  * @return #GNUNET_OK on success
2228  */
2229 static int
2230 udp_disconnect_session (void *cls,
2231                         struct GNUNET_ATS_Session *s)
2232 {
2233   struct Plugin *plugin = cls;
2234   struct UDP_MessageWrapper *udpw;
2235   struct UDP_MessageWrapper *next;
2236   struct FindReceiveContext frc;
2237
2238   GNUNET_assert (GNUNET_YES != s->in_destroy);
2239   LOG (GNUNET_ERROR_TYPE_DEBUG,
2240        "Session %p to peer `%s' at address %s ended\n",
2241        s,
2242        GNUNET_i2s (&s->target),
2243        udp_address_to_string (plugin,
2244                               s->address->address,
2245                               s->address->address_length));
2246   if (NULL != s->timeout_task)
2247   {
2248     GNUNET_SCHEDULER_cancel (s->timeout_task);
2249     s->timeout_task = NULL;
2250   }
2251   if (NULL != s->frag_ctx)
2252   {
2253     /* Remove fragmented message due to disconnect */
2254     fragmented_message_done (s->frag_ctx,
2255                              GNUNET_SYSERR);
2256   }
2257   GNUNET_assert (GNUNET_YES ==
2258                  GNUNET_CONTAINER_multipeermap_remove (plugin->sessions,
2259                                                        &s->target,
2260                                                        s));
2261   frc.rc = NULL;
2262   frc.udp_addr = s->address->address;
2263   frc.udp_addr_len = s->address->address_length;
2264   /* Lookup existing receive context for this address */
2265   if (NULL != plugin->defrag_ctxs)
2266   {
2267     GNUNET_CONTAINER_heap_iterate (plugin->defrag_ctxs,
2268                                    &find_receive_context,
2269                                    &frc);
2270     if (NULL != frc.rc)
2271     {
2272       struct DefragContext *d_ctx = frc.rc;
2273
2274       GNUNET_CONTAINER_heap_remove_node (d_ctx->hnode);
2275       GNUNET_DEFRAGMENT_context_destroy (d_ctx->defrag);
2276       GNUNET_free (d_ctx);
2277     }
2278   }
2279   s->in_destroy = GNUNET_YES;
2280   next = plugin->ipv4_queue_head;
2281   while (NULL != (udpw = next))
2282   {
2283     next = udpw->next;
2284     if (udpw->session == s)
2285     {
2286       dequeue (plugin,
2287                udpw);
2288       udpw->qc (udpw->qc_cls,
2289                 udpw,
2290                 GNUNET_SYSERR);
2291       GNUNET_free (udpw);
2292     }
2293   }
2294   next = plugin->ipv6_queue_head;
2295   while (NULL != (udpw = next))
2296   {
2297     next = udpw->next;
2298     if (udpw->session == s)
2299     {
2300       dequeue (plugin,
2301                udpw);
2302       udpw->qc (udpw->qc_cls,
2303                 udpw,
2304                 GNUNET_SYSERR);
2305       GNUNET_free (udpw);
2306     }
2307   }
2308   if ( (NULL != s->frag_ctx) &&
2309        (NULL != s->frag_ctx->cont) )
2310   {
2311     /* The 'frag_ctx' itself will be freed in #free_session() a bit
2312        later, as it might be in use right now */
2313     LOG (GNUNET_ERROR_TYPE_DEBUG,
2314          "Calling continuation for fragemented message to `%s' with result SYSERR\n",
2315          GNUNET_i2s (&s->target));
2316     s->frag_ctx->cont (s->frag_ctx->cont_cls,
2317                        &s->target,
2318                        GNUNET_SYSERR,
2319                        s->frag_ctx->payload_size,
2320                        s->frag_ctx->on_wire_size);
2321   }
2322   notify_session_monitor (s->plugin,
2323                           s,
2324                           GNUNET_TRANSPORT_SS_DONE);
2325   plugin->env->session_end (plugin->env->cls,
2326                             s->address,
2327                             s);
2328   GNUNET_STATISTICS_set (plugin->env->stats,
2329                          "# UDP sessions active",
2330                          GNUNET_CONTAINER_multipeermap_size (plugin->sessions),
2331                          GNUNET_NO);
2332   if (0 == s->rc)
2333     free_session (s);
2334   return GNUNET_OK;
2335 }
2336
2337
2338 /**
2339  * Handle a #GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_ACK message.
2340  *
2341  * @param plugin the UDP plugin
2342  * @param msg the (presumed) UDP ACK message
2343  * @param udp_addr sender address
2344  * @param udp_addr_len number of bytes in @a udp_addr
2345  */
2346 static void
2347 read_process_ack (struct Plugin *plugin,
2348                   const struct GNUNET_MessageHeader *msg,
2349                   const union UdpAddress *udp_addr,
2350                   socklen_t udp_addr_len)
2351 {
2352   const struct GNUNET_MessageHeader *ack;
2353   const struct UDP_ACK_Message *udp_ack;
2354   struct GNUNET_HELLO_Address *address;
2355   struct GNUNET_ATS_Session *s;
2356   struct GNUNET_TIME_Relative flow_delay;
2357
2358   /* check message format */
2359   if (ntohs (msg->size)
2360       < sizeof(struct UDP_ACK_Message) + sizeof(struct GNUNET_MessageHeader))
2361   {
2362     GNUNET_break_op (0);
2363     return;
2364   }
2365   udp_ack = (const struct UDP_ACK_Message *) msg;
2366   ack = (const struct GNUNET_MessageHeader *) &udp_ack[1];
2367   if (ntohs (ack->size) != ntohs (msg->size) - sizeof(struct UDP_ACK_Message))
2368   {
2369     GNUNET_break_op(0);
2370     return;
2371   }
2372
2373   /* Locate session */
2374   address = GNUNET_HELLO_address_allocate (&udp_ack->sender,
2375                                            PLUGIN_NAME,
2376                                            udp_addr,
2377                                            udp_addr_len,
2378                                            GNUNET_HELLO_ADDRESS_INFO_NONE);
2379   s = udp_plugin_lookup_session (plugin,
2380                                  address);
2381   if (NULL == s)
2382   {
2383     LOG (GNUNET_ERROR_TYPE_WARNING,
2384          "UDP session of address %s for ACK not found\n",
2385          udp_address_to_string (plugin,
2386                                 address->address,
2387                                 address->address_length));
2388     GNUNET_HELLO_address_free (address);
2389     return;
2390   }
2391   if (NULL == s->frag_ctx)
2392   {
2393     LOG (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
2394          "Fragmentation context of address %s for ACK (%s) not found\n",
2395          udp_address_to_string (plugin,
2396                                 address->address,
2397                                 address->address_length),
2398          GNUNET_FRAGMENT_print_ack (ack));
2399     GNUNET_HELLO_address_free (address);
2400     return;
2401   }
2402   GNUNET_HELLO_address_free (address);
2403
2404   /* evaluate flow delay: how long should we wait between messages? */
2405   if (UINT32_MAX == ntohl (udp_ack->delay))
2406   {
2407     /* Other peer asked for us to terminate the session */
2408     LOG (GNUNET_ERROR_TYPE_INFO,
2409          "Asked to disconnect UDP session of %s\n",
2410          GNUNET_i2s (&udp_ack->sender));
2411     udp_disconnect_session (plugin,
2412                             s);
2413     return;
2414   }
2415   flow_delay.rel_value_us = (uint64_t) ntohl (udp_ack->delay);
2416   if (flow_delay.rel_value_us > GNUNET_CONSTANTS_LATENCY_WARN.rel_value_us)
2417     LOG (GNUNET_ERROR_TYPE_WARNING,
2418          "We received a sending delay of %s for %s\n",
2419          GNUNET_STRINGS_relative_time_to_string (flow_delay,
2420                                                  GNUNET_YES),
2421          GNUNET_i2s (&udp_ack->sender));
2422   else
2423     LOG (GNUNET_ERROR_TYPE_DEBUG,
2424          "We received a sending delay of %s for %s\n",
2425          GNUNET_STRINGS_relative_time_to_string (flow_delay,
2426                                                  GNUNET_YES),
2427          GNUNET_i2s (&udp_ack->sender));
2428   /* Flow delay is for the reassembled packet, however, our delay
2429      is per packet, so we need to adjust: */
2430   s->flow_delay_from_other_peer = flow_delay;
2431
2432   /* Handle ACK */
2433   if (GNUNET_OK !=
2434       GNUNET_FRAGMENT_process_ack (s->frag_ctx->frag,
2435                                    ack))
2436   {
2437     LOG (GNUNET_ERROR_TYPE_DEBUG,
2438          "UDP processes %u-byte acknowledgement from `%s' at `%s'\n",
2439          (unsigned int) ntohs (msg->size),
2440          GNUNET_i2s (&udp_ack->sender),
2441          udp_address_to_string (plugin,
2442                                 udp_addr,
2443                                 udp_addr_len));
2444     /* Expect more ACKs to arrive */
2445     return;
2446   }
2447
2448   /* Remove fragmented message after successful sending */
2449   LOG (GNUNET_ERROR_TYPE_DEBUG,
2450        "Message from %s at %s full ACK'ed\n",
2451        GNUNET_i2s (&udp_ack->sender),
2452        udp_address_to_string (plugin,
2453                               udp_addr,
2454                               udp_addr_len));
2455   fragmented_message_done (s->frag_ctx,
2456                            GNUNET_OK);
2457 }
2458
2459
2460 /**
2461  * Message tokenizer has broken up an incomming message. Pass it on
2462  * to the service.
2463  *
2464  * @param cls the `struct Plugin *`
2465  * @param client the `struct GNUNET_ATS_Session *`
2466  * @param hdr the actual message
2467  * @return #GNUNET_OK (always)
2468  */
2469 static int
2470 process_inbound_tokenized_messages (void *cls,
2471                                     void *client,
2472                                     const struct GNUNET_MessageHeader *hdr)
2473 {
2474   struct Plugin *plugin = cls;
2475   struct GNUNET_ATS_Session *session = client;
2476
2477   if (GNUNET_YES == session->in_destroy)
2478     return GNUNET_OK;
2479   reschedule_session_timeout (session);
2480   session->flow_delay_for_other_peer
2481     = plugin->env->receive (plugin->env->cls,
2482                             session->address,
2483                             session,
2484                             hdr);
2485   return GNUNET_OK;
2486 }
2487
2488
2489 /**
2490  * Destroy a session, plugin is being unloaded.
2491  *
2492  * @param cls the `struct Plugin`
2493  * @param key hash of public key of target peer
2494  * @param value a `struct PeerSession *` to clean up
2495  * @return #GNUNET_OK (continue to iterate)
2496  */
2497 static int
2498 disconnect_and_free_it (void *cls,
2499                         const struct GNUNET_PeerIdentity *key,
2500                         void *value)
2501 {
2502   struct Plugin *plugin = cls;
2503
2504   udp_disconnect_session (plugin,
2505                           value);
2506   return GNUNET_OK;
2507 }
2508
2509
2510 /**
2511  * Disconnect from a remote node.  Clean up session if we have one for
2512  * this peer.
2513  *
2514  * @param cls closure for this call (should be handle to Plugin)
2515  * @param target the peeridentity of the peer to disconnect
2516  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the operation failed
2517  */
2518 static void
2519 udp_disconnect (void *cls,
2520                 const struct GNUNET_PeerIdentity *target)
2521 {
2522   struct Plugin *plugin = cls;
2523
2524   LOG (GNUNET_ERROR_TYPE_DEBUG,
2525        "Disconnecting from peer `%s'\n",
2526        GNUNET_i2s (target));
2527   GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessions,
2528                                               target,
2529                                               &disconnect_and_free_it,
2530                                               plugin);
2531 }
2532
2533
2534 /**
2535  * Session was idle, so disconnect it.
2536  *
2537  * @param cls the `struct GNUNET_ATS_Session` to time out
2538  * @param tc scheduler context
2539  */
2540 static void
2541 session_timeout (void *cls,
2542                  const struct GNUNET_SCHEDULER_TaskContext *tc)
2543 {
2544   struct GNUNET_ATS_Session *s = cls;
2545   struct Plugin *plugin = s->plugin;
2546   struct GNUNET_TIME_Relative left;
2547
2548   s->timeout_task = NULL;
2549   left = GNUNET_TIME_absolute_get_remaining (s->timeout);
2550   if (left.rel_value_us > 0)
2551   {
2552     /* not actually our turn yet, but let's at least update
2553        the monitor, it may think we're about to die ... */
2554     notify_session_monitor (s->plugin,
2555                             s,
2556                             GNUNET_TRANSPORT_SS_UPDATE);
2557     s->timeout_task = GNUNET_SCHEDULER_add_delayed (left,
2558                                                     &session_timeout,
2559                                                     s);
2560     return;
2561   }
2562   LOG (GNUNET_ERROR_TYPE_DEBUG,
2563        "Session %p was idle for %s, disconnecting\n",
2564        s,
2565        GNUNET_STRINGS_relative_time_to_string (UDP_SESSION_TIME_OUT,
2566                                                GNUNET_YES));
2567   /* call session destroy function */
2568   udp_disconnect_session (plugin,
2569                           s);
2570 }
2571
2572
2573 /**
2574  * Allocate a new session for the given endpoint address.
2575  * Note that this function does not inform the service
2576  * of the new session, this is the responsibility of the
2577  * caller (if needed).
2578  *
2579  * @param cls the `struct Plugin`
2580  * @param address address of the other peer to use
2581  * @param network_type network type the address belongs to
2582  * @return NULL on error, otherwise session handle
2583  */
2584 static struct GNUNET_ATS_Session *
2585 udp_plugin_create_session (void *cls,
2586                            const struct GNUNET_HELLO_Address *address,
2587                            enum GNUNET_ATS_Network_Type network_type)
2588 {
2589   struct Plugin *plugin = cls;
2590   struct GNUNET_ATS_Session *s;
2591
2592   s = GNUNET_new (struct GNUNET_ATS_Session);
2593   s->plugin = plugin;
2594   s->address = GNUNET_HELLO_address_copy (address);
2595   s->target = address->peer;
2596   s->last_transmit_time = GNUNET_TIME_absolute_get ();
2597   s->last_expected_ack_delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
2598                                                               250);
2599   s->last_expected_msg_delay = GNUNET_TIME_UNIT_MILLISECONDS;
2600   s->flow_delay_from_other_peer = GNUNET_TIME_UNIT_ZERO;
2601   s->flow_delay_for_other_peer = GNUNET_TIME_UNIT_ZERO;
2602   s->timeout = GNUNET_TIME_relative_to_absolute (UDP_SESSION_TIME_OUT);
2603   s->timeout_task = GNUNET_SCHEDULER_add_delayed (UDP_SESSION_TIME_OUT,
2604                                                   &session_timeout,
2605                                                   s);
2606   s->scope = network_type;
2607
2608   LOG (GNUNET_ERROR_TYPE_DEBUG,
2609        "Creating new session %p for peer `%s' address `%s'\n",
2610        s,
2611        GNUNET_i2s (&address->peer),
2612        udp_address_to_string (plugin,
2613                               address->address,
2614                               address->address_length));
2615   GNUNET_assert (GNUNET_OK ==
2616                  GNUNET_CONTAINER_multipeermap_put (plugin->sessions,
2617                                                     &s->target,
2618                                                     s,
2619                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
2620   GNUNET_STATISTICS_set (plugin->env->stats,
2621                          "# UDP sessions active",
2622                          GNUNET_CONTAINER_multipeermap_size (plugin->sessions),
2623                          GNUNET_NO);
2624   notify_session_monitor (plugin,
2625                           s,
2626                           GNUNET_TRANSPORT_SS_INIT);
2627   return s;
2628 }
2629
2630
2631 /**
2632  * Creates a new outbound session the transport service will use to
2633  * send data to the peer.
2634  *
2635  * @param cls the `struct Plugin *`
2636  * @param address the address
2637  * @return the session or NULL of max connections exceeded
2638  */
2639 static struct GNUNET_ATS_Session *
2640 udp_plugin_get_session (void *cls,
2641                         const struct GNUNET_HELLO_Address *address)
2642 {
2643   struct Plugin *plugin = cls;
2644   struct GNUNET_ATS_Session *s;
2645   enum GNUNET_ATS_Network_Type network_type = GNUNET_ATS_NET_UNSPECIFIED;
2646   const struct IPv4UdpAddress *udp_v4;
2647   const struct IPv6UdpAddress *udp_v6;
2648
2649   if (NULL == address)
2650   {
2651     GNUNET_break (0);
2652     return NULL;
2653   }
2654   if ( (address->address_length != sizeof(struct IPv4UdpAddress)) &&
2655        (address->address_length != sizeof(struct IPv6UdpAddress)) )
2656   {
2657     GNUNET_break_op (0);
2658     return NULL;
2659   }
2660   if (NULL != (s = udp_plugin_lookup_session (cls,
2661                                               address)))
2662     return s;
2663
2664   /* need to create new session */
2665   if (sizeof (struct IPv4UdpAddress) == address->address_length)
2666   {
2667     struct sockaddr_in v4;
2668
2669     udp_v4 = (const struct IPv4UdpAddress *) address->address;
2670     memset (&v4, '\0', sizeof (v4));
2671     v4.sin_family = AF_INET;
2672 #if HAVE_SOCKADDR_IN_SIN_LEN
2673     v4.sin_len = sizeof (struct sockaddr_in);
2674 #endif
2675     v4.sin_port = udp_v4->u4_port;
2676     v4.sin_addr.s_addr = udp_v4->ipv4_addr;
2677     network_type = plugin->env->get_address_type (plugin->env->cls,
2678                                                   (const struct sockaddr *) &v4,
2679                                                   sizeof (v4));
2680   }
2681   if (sizeof (struct IPv6UdpAddress) == address->address_length)
2682   {
2683     struct sockaddr_in6 v6;
2684
2685     udp_v6 = (const struct IPv6UdpAddress *) address->address;
2686     memset (&v6, '\0', sizeof (v6));
2687     v6.sin6_family = AF_INET6;
2688 #if HAVE_SOCKADDR_IN_SIN_LEN
2689     v6.sin6_len = sizeof (struct sockaddr_in6);
2690 #endif
2691     v6.sin6_port = udp_v6->u6_port;
2692     v6.sin6_addr = udp_v6->ipv6_addr;
2693     network_type = plugin->env->get_address_type (plugin->env->cls,
2694                                                   (const struct sockaddr *) &v6,
2695                                                   sizeof (v6));
2696   }
2697   GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != network_type);
2698   return udp_plugin_create_session (cls,
2699                                     address,
2700                                     network_type);
2701 }
2702
2703
2704 /**
2705  * We've received a UDP Message.  Process it (pass contents to main service).
2706  *
2707  * @param plugin plugin context
2708  * @param msg the message
2709  * @param udp_addr sender address
2710  * @param udp_addr_len number of bytes in @a udp_addr
2711  * @param network_type network type the address belongs to
2712  */
2713 static void
2714 process_udp_message (struct Plugin *plugin,
2715                      const struct UDPMessage *msg,
2716                      const union UdpAddress *udp_addr,
2717                      size_t udp_addr_len,
2718                      enum GNUNET_ATS_Network_Type network_type)
2719 {
2720   struct GNUNET_ATS_Session *s;
2721   struct GNUNET_HELLO_Address *address;
2722
2723   GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != network_type);
2724   if (0 != ntohl (msg->reserved))
2725   {
2726     GNUNET_break_op(0);
2727     return;
2728   }
2729   if (ntohs (msg->header.size)
2730       < sizeof(struct GNUNET_MessageHeader) + sizeof(struct UDPMessage))
2731   {
2732     GNUNET_break_op(0);
2733     return;
2734   }
2735
2736   address = GNUNET_HELLO_address_allocate (&msg->sender,
2737                                            PLUGIN_NAME,
2738                                            udp_addr,
2739                                            udp_addr_len,
2740                                            GNUNET_HELLO_ADDRESS_INFO_NONE);
2741   if (NULL ==
2742       (s = udp_plugin_lookup_session (plugin,
2743                                       address)))
2744   {
2745     s = udp_plugin_create_session (plugin,
2746                                    address,
2747                                    network_type);
2748     plugin->env->session_start (plugin->env->cls,
2749                                 address,
2750                                 s,
2751                                 s->scope);
2752     notify_session_monitor (plugin,
2753                             s,
2754                             GNUNET_TRANSPORT_SS_UP);
2755   }
2756   GNUNET_free (address);
2757
2758   s->rc++;
2759   GNUNET_SERVER_mst_receive (plugin->mst,
2760                              s,
2761                              (const char *) &msg[1],
2762                              ntohs (msg->header.size) - sizeof(struct UDPMessage),
2763                              GNUNET_YES,
2764                              GNUNET_NO);
2765   s->rc--;
2766   if ( (0 == s->rc) &&
2767        (GNUNET_YES == s->in_destroy) )
2768     free_session (s);
2769 }
2770
2771
2772 /**
2773  * Process a defragmented message.
2774  *
2775  * @param cls the `struct DefragContext *`
2776  * @param msg the message
2777  */
2778 static void
2779 fragment_msg_proc (void *cls,
2780                    const struct GNUNET_MessageHeader *msg)
2781 {
2782   struct DefragContext *dc = cls;
2783   const struct UDPMessage *um;
2784
2785   if (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_MESSAGE)
2786   {
2787     GNUNET_break_op (0);
2788     return;
2789   }
2790   if (ntohs (msg->size) < sizeof(struct UDPMessage))
2791   {
2792     GNUNET_break_op (0);
2793     return;
2794   }
2795   um = (const struct UDPMessage *) msg;
2796   dc->sender = um->sender;
2797   dc->have_sender = GNUNET_YES;
2798   process_udp_message (dc->plugin,
2799                        um,
2800                        dc->udp_addr,
2801                        dc->udp_addr_len,
2802                        dc->network_type);
2803 }
2804
2805
2806 /**
2807  * We finished sending an acknowledgement.  Update
2808  * statistics.
2809  *
2810  * @param cls the `struct Plugin`
2811  * @param udpw message queue entry of the ACK
2812  * @param result #GNUNET_OK if the transmission worked,
2813  *               #GNUNET_SYSERR if we failed to send the ACK
2814  */
2815 static void
2816 ack_message_sent (void *cls,
2817                   struct UDP_MessageWrapper *udpw,
2818                   int result)
2819 {
2820   struct Plugin *plugin = cls;
2821
2822   if (GNUNET_OK == result)
2823   {
2824     GNUNET_STATISTICS_update (plugin->env->stats,
2825                               "# UDP, ACK messages sent",
2826                               1,
2827                               GNUNET_NO);
2828   }
2829   else
2830   {
2831     GNUNET_STATISTICS_update (plugin->env->stats,
2832                               "# UDP, ACK transmissions failed",
2833                               1,
2834                               GNUNET_NO);
2835   }
2836 }
2837
2838
2839 /**
2840  * Transmit an acknowledgement.
2841  *
2842  * @param cls the `struct DefragContext *`
2843  * @param id message ID (unused)
2844  * @param msg ack to transmit
2845  */
2846 static void
2847 ack_proc (void *cls,
2848           uint32_t id,
2849           const struct GNUNET_MessageHeader *msg)
2850 {
2851   struct DefragContext *rc = cls;
2852   struct Plugin *plugin = rc->plugin;
2853   size_t msize = sizeof(struct UDP_ACK_Message) + ntohs (msg->size);
2854   struct UDP_ACK_Message *udp_ack;
2855   uint32_t delay;
2856   struct UDP_MessageWrapper *udpw;
2857   struct GNUNET_ATS_Session *s;
2858   struct GNUNET_HELLO_Address *address;
2859
2860   if (GNUNET_NO == rc->have_sender)
2861   {
2862     /* tried to defragment but never succeeded, hence will not ACK */
2863     /* This can happen if we just lost msgs */
2864     GNUNET_STATISTICS_update (plugin->env->stats,
2865                               "# UDP, fragments discarded without ACK",
2866                               1,
2867                               GNUNET_NO);
2868     return;
2869   }
2870   address = GNUNET_HELLO_address_allocate (&rc->sender,
2871                                            PLUGIN_NAME,
2872                                            rc->udp_addr,
2873                                            rc->udp_addr_len,
2874                                            GNUNET_HELLO_ADDRESS_INFO_NONE);
2875   s = udp_plugin_lookup_session (plugin,
2876                                  address);
2877   GNUNET_HELLO_address_free (address);
2878   if (NULL == s)
2879   {
2880     LOG (GNUNET_ERROR_TYPE_ERROR,
2881          "Trying to transmit ACK to peer `%s' but no session found!\n",
2882          udp_address_to_string (plugin,
2883                                 rc->udp_addr,
2884                                 rc->udp_addr_len));
2885     GNUNET_CONTAINER_heap_remove_node (rc->hnode);
2886     GNUNET_DEFRAGMENT_context_destroy (rc->defrag);
2887     GNUNET_free (rc);
2888     GNUNET_STATISTICS_update (plugin->env->stats,
2889                               "# UDP, ACK transmissions failed",
2890                               1,
2891                               GNUNET_NO);
2892     return;
2893   }
2894   if (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us ==
2895       s->flow_delay_for_other_peer.rel_value_us)
2896     delay = UINT32_MAX;
2897   else if (s->flow_delay_for_other_peer.rel_value_us < UINT32_MAX)
2898     delay = s->flow_delay_for_other_peer.rel_value_us;
2899   else
2900     delay = UINT32_MAX - 1; /* largest value we can communicate */
2901   LOG (GNUNET_ERROR_TYPE_DEBUG,
2902        "Sending ACK to `%s' including delay of %s\n",
2903        udp_address_to_string (plugin,
2904                               rc->udp_addr,
2905                               rc->udp_addr_len),
2906        GNUNET_STRINGS_relative_time_to_string (s->flow_delay_for_other_peer,
2907                                                GNUNET_YES));
2908   udpw = GNUNET_malloc (sizeof (struct UDP_MessageWrapper) + msize);
2909   udpw->msg_size = msize;
2910   udpw->payload_size = 0;
2911   udpw->session = s;
2912   udpw->start_time = GNUNET_TIME_absolute_get ();
2913   udpw->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
2914   udpw->msg_buf = (char *) &udpw[1];
2915   udpw->qc = &ack_message_sent;
2916   udpw->qc_cls = plugin;
2917   udp_ack = (struct UDP_ACK_Message *) udpw->msg_buf;
2918   udp_ack->header.size = htons ((uint16_t) msize);
2919   udp_ack->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_ACK);
2920   udp_ack->delay = htonl (delay);
2921   udp_ack->sender = *plugin->env->my_identity;
2922   memcpy (&udp_ack[1],
2923           msg,
2924           ntohs (msg->size));
2925   enqueue (plugin,
2926            udpw);
2927   notify_session_monitor (plugin,
2928                           s,
2929                           GNUNET_TRANSPORT_SS_UPDATE);
2930   if (s->address->address_length == sizeof (struct IPv4UdpAddress))
2931     schedule_select_v4 (plugin);
2932   else
2933     schedule_select_v6 (plugin);
2934 }
2935
2936
2937 /**
2938  * We received a fragment, process it.
2939  *
2940  * @param plugin our plugin
2941  * @param msg a message of type #GNUNET_MESSAGE_TYPE_FRAGMENT
2942  * @param udp_addr sender address
2943  * @param udp_addr_len number of bytes in @a udp_addr
2944  * @param network_type network type the address belongs to
2945  */
2946 static void
2947 read_process_fragment (struct Plugin *plugin,
2948                        const struct GNUNET_MessageHeader *msg,
2949                        const union UdpAddress *udp_addr,
2950                        size_t udp_addr_len,
2951                        enum GNUNET_ATS_Network_Type network_type)
2952 {
2953   struct DefragContext *d_ctx;
2954   struct GNUNET_TIME_Absolute now;
2955   struct FindReceiveContext frc;
2956
2957   frc.rc = NULL;
2958   frc.udp_addr = udp_addr;
2959   frc.udp_addr_len = udp_addr_len;
2960
2961   /* Lookup existing receive context for this address */
2962   GNUNET_CONTAINER_heap_iterate (plugin->defrag_ctxs,
2963                                  &find_receive_context,
2964                                  &frc);
2965   now = GNUNET_TIME_absolute_get ();
2966   d_ctx = frc.rc;
2967
2968   if (NULL == d_ctx)
2969   {
2970     /* Create a new defragmentation context */
2971     d_ctx = GNUNET_malloc (sizeof (struct DefragContext) + udp_addr_len);
2972     memcpy (&d_ctx[1],
2973             udp_addr,
2974             udp_addr_len);
2975     d_ctx->udp_addr = (const union UdpAddress *) &d_ctx[1];
2976     d_ctx->udp_addr_len = udp_addr_len;
2977     d_ctx->network_type = network_type;
2978     d_ctx->plugin = plugin;
2979     d_ctx->defrag = GNUNET_DEFRAGMENT_context_create (plugin->env->stats,
2980                                                       UDP_MTU,
2981                                                       UDP_MAX_MESSAGES_IN_DEFRAG,
2982                                                       d_ctx,
2983                                                       &fragment_msg_proc,
2984                                                       &ack_proc);
2985     d_ctx->hnode = GNUNET_CONTAINER_heap_insert (plugin->defrag_ctxs,
2986                                                  d_ctx,
2987                                                  (GNUNET_CONTAINER_HeapCostType) now.abs_value_us);
2988     LOG (GNUNET_ERROR_TYPE_DEBUG,
2989          "Created new defragmentation context for %u-byte fragment from `%s'\n",
2990          (unsigned int) ntohs (msg->size),
2991          udp_address_to_string (plugin,
2992                                 udp_addr,
2993                                 udp_addr_len));
2994   }
2995   else
2996   {
2997     LOG (GNUNET_ERROR_TYPE_DEBUG,
2998          "Found existing defragmentation context for %u-byte fragment from `%s'\n",
2999          (unsigned int) ntohs (msg->size),
3000          udp_address_to_string (plugin,
3001                                 udp_addr,
3002                                 udp_addr_len));
3003   }
3004
3005   if (GNUNET_OK ==
3006       GNUNET_DEFRAGMENT_process_fragment (d_ctx->defrag,
3007                                           msg))
3008   {
3009     /* keep this 'rc' from expiring */
3010     GNUNET_CONTAINER_heap_update_cost (plugin->defrag_ctxs,
3011                                        d_ctx->hnode,
3012                                        (GNUNET_CONTAINER_HeapCostType) now.abs_value_us);
3013   }
3014   if (GNUNET_CONTAINER_heap_get_size (plugin->defrag_ctxs) >
3015       UDP_MAX_SENDER_ADDRESSES_WITH_DEFRAG)
3016   {
3017     /* remove 'rc' that was inactive the longest */
3018     d_ctx = GNUNET_CONTAINER_heap_remove_root (plugin->defrag_ctxs);
3019     GNUNET_assert (NULL != d_ctx);
3020     GNUNET_DEFRAGMENT_context_destroy (d_ctx->defrag);
3021     GNUNET_free (d_ctx);
3022     GNUNET_STATISTICS_update (plugin->env->stats,
3023                               "# UDP, Defragmentations aborted",
3024                               1,
3025                               GNUNET_NO);
3026   }
3027 }
3028
3029
3030 /**
3031  * Read and process a message from the given socket.
3032  *
3033  * @param plugin the overall plugin
3034  * @param rsock socket to read from
3035  */
3036 static void
3037 udp_select_read (struct Plugin *plugin,
3038                  struct GNUNET_NETWORK_Handle *rsock)
3039 {
3040   socklen_t fromlen;
3041   struct sockaddr_storage addr;
3042   char buf[65536] GNUNET_ALIGN;
3043   ssize_t size;
3044   const struct GNUNET_MessageHeader *msg;
3045   struct IPv4UdpAddress v4;
3046   struct IPv6UdpAddress v6;
3047   const struct sockaddr *sa;
3048   const struct sockaddr_in *sa4;
3049   const struct sockaddr_in6 *sa6;
3050   const union UdpAddress *int_addr;
3051   size_t int_addr_len;
3052   enum GNUNET_ATS_Network_Type network_type;
3053
3054   fromlen = sizeof (addr);
3055   memset (&addr,
3056           0,
3057           sizeof(addr));
3058   size = GNUNET_NETWORK_socket_recvfrom (rsock,
3059                                          buf,
3060                                          sizeof(buf),
3061                                          (struct sockaddr *) &addr,
3062                                          &fromlen);
3063   sa = (const struct sockaddr *) &addr;
3064 #if MINGW
3065   /* On SOCK_DGRAM UDP sockets recvfrom might fail with a
3066    * WSAECONNRESET error to indicate that previous sendto() (yes, sendto!)
3067    * on this socket has failed.
3068    * Quote from MSDN:
3069    *   WSAECONNRESET - The virtual circuit was reset by the remote side
3070    *   executing a hard or abortive close. The application should close
3071    *   the socket; it is no longer usable. On a UDP-datagram socket this
3072    *   error indicates a previous send operation resulted in an ICMP Port
3073    *   Unreachable message.
3074    */
3075   if ( (-1 == size) &&
3076        (ECONNRESET == errno) )
3077     return;
3078 #endif
3079   if (-1 == size)
3080   {
3081     LOG (GNUNET_ERROR_TYPE_DEBUG,
3082          "UDP failed to receive data: %s\n",
3083          STRERROR (errno));
3084     /* Connection failure or something. Not a protocol violation. */
3085     return;
3086   }
3087
3088   /* Check if this is a STUN packet */
3089   if (GNUNET_NAT_is_valid_stun_packet (plugin->nat,
3090                                        (uint8_t *)buf,
3091                                        size))
3092     return; /* was STUN, do not process further */
3093
3094   if (size < sizeof(struct GNUNET_MessageHeader))
3095   {
3096     LOG (GNUNET_ERROR_TYPE_WARNING,
3097          "UDP got %u bytes from %s, which is not enough for a GNUnet message header\n",
3098          (unsigned int ) size,
3099          GNUNET_a2s (sa,
3100                      fromlen));
3101     /* _MAY_ be a connection failure (got partial message) */
3102     /* But it _MAY_ also be that the other side uses non-GNUnet protocol. */
3103     GNUNET_break_op (0);
3104     return;
3105   }
3106
3107   msg = (const struct GNUNET_MessageHeader *) buf;
3108   LOG (GNUNET_ERROR_TYPE_DEBUG,
3109        "UDP received %u-byte message from `%s' type %u\n",
3110        (unsigned int) size,
3111        GNUNET_a2s (sa,
3112                    fromlen),
3113        ntohs (msg->type));
3114   if (size != ntohs (msg->size))
3115   {
3116     LOG (GNUNET_ERROR_TYPE_WARNING,
3117          "UDP malformed message header from %s\n",
3118          (unsigned int) size,
3119          GNUNET_a2s (sa,
3120                      fromlen));
3121     GNUNET_break_op (0);
3122     return;
3123   }
3124   GNUNET_STATISTICS_update (plugin->env->stats,
3125                             "# UDP, total bytes received",
3126                             size,
3127                             GNUNET_NO);
3128   network_type = plugin->env->get_address_type (plugin->env->cls,
3129                                                 sa,
3130                                                 fromlen);
3131   switch (sa->sa_family)
3132   {
3133   case AF_INET:
3134     sa4 = (const struct sockaddr_in *) &addr;
3135     v4.options = 0;
3136     v4.ipv4_addr = sa4->sin_addr.s_addr;
3137     v4.u4_port = sa4->sin_port;
3138     int_addr = (union UdpAddress *) &v4;
3139     int_addr_len = sizeof (v4);
3140     break;
3141   case AF_INET6:
3142     sa6 = (const struct sockaddr_in6 *) &addr;
3143     v6.options = 0;
3144     v6.ipv6_addr = sa6->sin6_addr;
3145     v6.u6_port = sa6->sin6_port;
3146     int_addr = (union UdpAddress *) &v6;
3147     int_addr_len = sizeof (v6);
3148     break;
3149   default:
3150     GNUNET_break (0);
3151     return;
3152   }
3153
3154   switch (ntohs (msg->type))
3155   {
3156   case GNUNET_MESSAGE_TYPE_TRANSPORT_BROADCAST_BEACON:
3157     if (GNUNET_YES == plugin->enable_broadcasting_receiving)
3158       udp_broadcast_receive (plugin,
3159                              buf,
3160                              size,
3161                              int_addr,
3162                              int_addr_len,
3163                              network_type);
3164     return;
3165   case GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_MESSAGE:
3166     if (ntohs (msg->size) < sizeof(struct UDPMessage))
3167     {
3168       GNUNET_break_op(0);
3169       return;
3170     }
3171     process_udp_message (plugin,
3172                          (const struct UDPMessage *) msg,
3173                          int_addr,
3174                          int_addr_len,
3175                          network_type);
3176     return;
3177   case GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_ACK:
3178     read_process_ack (plugin,
3179                       msg,
3180                       int_addr,
3181                       int_addr_len);
3182     return;
3183   case GNUNET_MESSAGE_TYPE_FRAGMENT:
3184     read_process_fragment (plugin,
3185                            msg,
3186                            int_addr,
3187                            int_addr_len,
3188                            network_type);
3189     return;
3190   default:
3191     GNUNET_break_op(0);
3192     return;
3193   }
3194 }
3195
3196
3197 /**
3198  * Removes messages from the transmission queue that have
3199  * timed out, and then selects a message that should be
3200  * transmitted next.
3201  *
3202  * @param plugin the UDP plugin
3203  * @param sock which socket should we process the queue for (v4 or v6)
3204  * @return message selected for transmission, or NULL for none
3205  */
3206 static struct UDP_MessageWrapper *
3207 remove_timeout_messages_and_select (struct Plugin *plugin,
3208                                     struct GNUNET_NETWORK_Handle *sock)
3209 {
3210   struct UDP_MessageWrapper *udpw;
3211   struct GNUNET_TIME_Relative remaining;
3212   struct GNUNET_ATS_Session *session;
3213   int removed;
3214
3215   removed = GNUNET_NO;
3216   udpw = (sock == plugin->sockv4)
3217     ? plugin->ipv4_queue_head
3218     : plugin->ipv6_queue_head;
3219   while (NULL != udpw)
3220   {
3221     session = udpw->session;
3222     /* Find messages with timeout */
3223     remaining = GNUNET_TIME_absolute_get_remaining (udpw->timeout);
3224     if (GNUNET_TIME_UNIT_ZERO.rel_value_us == remaining.rel_value_us)
3225     {
3226       /* Message timed out */
3227       removed = GNUNET_YES;
3228       dequeue (plugin,
3229                udpw);
3230       udpw->qc (udpw->qc_cls,
3231                 udpw,
3232                 GNUNET_SYSERR);
3233       GNUNET_free (udpw);
3234
3235       if (sock == plugin->sockv4)
3236       {
3237         udpw = plugin->ipv4_queue_head;
3238       }
3239       else if (sock == plugin->sockv6)
3240       {
3241         udpw = plugin->ipv6_queue_head;
3242       }
3243       else
3244       {
3245         GNUNET_break (0); /* should never happen */
3246         udpw = NULL;
3247       }
3248       GNUNET_STATISTICS_update (plugin->env->stats,
3249                                 "# messages discarded due to timeout",
3250                                 1,
3251                                 GNUNET_NO);
3252     }
3253     else
3254     {
3255       /* Message did not time out, check transmission time */
3256       remaining = GNUNET_TIME_absolute_get_remaining (udpw->transmission_time);
3257       if (0 == remaining.rel_value_us)
3258       {
3259         /* this message is not delayed */
3260         LOG (GNUNET_ERROR_TYPE_DEBUG,
3261              "Message for peer `%s' (%u bytes) is not delayed \n",
3262              GNUNET_i2s (&udpw->session->target),
3263              udpw->payload_size);
3264         break; /* Found message to send, break */
3265       }
3266       else
3267       {
3268         /* Message is delayed, try next */
3269         LOG (GNUNET_ERROR_TYPE_DEBUG,
3270              "Message for peer `%s' (%u bytes) is delayed for %s\n",
3271              GNUNET_i2s (&udpw->session->target),
3272              udpw->payload_size,
3273              GNUNET_STRINGS_relative_time_to_string (remaining,
3274                                                      GNUNET_YES));
3275         udpw = udpw->next;
3276       }
3277     }
3278   }
3279   if (GNUNET_YES == removed)
3280     notify_session_monitor (session->plugin,
3281                             session,
3282                             GNUNET_TRANSPORT_SS_UPDATE);
3283   return udpw;
3284 }
3285
3286
3287 /**
3288  * We failed to transmit a message via UDP. Generate
3289  * a descriptive error message.
3290  *
3291  * @param plugin our plugin
3292  * @param sa target address we were trying to reach
3293  * @param slen number of bytes in @a sa
3294  * @param error the errno value returned from the sendto() call
3295  */
3296 static void
3297 analyze_send_error (struct Plugin *plugin,
3298                     const struct sockaddr *sa,
3299                     socklen_t slen,
3300                     int error)
3301 {
3302   enum GNUNET_ATS_Network_Type type;
3303
3304   type = plugin->env->get_address_type (plugin->env->cls,
3305                                         sa,
3306                                         slen);
3307   if ( ( (GNUNET_ATS_NET_LAN == type) ||
3308          (GNUNET_ATS_NET_WAN == type) ) &&
3309        ( (ENETUNREACH == errno) ||
3310          (ENETDOWN == errno) ) )
3311   {
3312     if (slen == sizeof (struct sockaddr_in))
3313     {
3314       /* IPv4: "Network unreachable" or "Network down"
3315        *
3316        * This indicates we do not have connectivity
3317        */
3318       LOG (GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
3319            _("UDP could not transmit message to `%s': "
3320              "Network seems down, please check your network configuration\n"),
3321            GNUNET_a2s (sa,
3322                        slen));
3323     }
3324     if (slen == sizeof (struct sockaddr_in6))
3325     {
3326       /* IPv6: "Network unreachable" or "Network down"
3327        *
3328        * This indicates that this system is IPv6 enabled, but does not
3329        * have a valid global IPv6 address assigned or we do not have
3330        * connectivity
3331        */
3332       LOG (GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
3333            _("UDP could not transmit IPv6 message! "
3334              "Please check your network configuration and disable IPv6 if your "
3335              "connection does not have a global IPv6 address\n"));
3336     }
3337   }
3338   else
3339   {
3340     LOG (GNUNET_ERROR_TYPE_WARNING,
3341          "UDP could not transmit message to `%s': `%s'\n",
3342          GNUNET_a2s (sa,
3343                      slen),
3344          STRERROR (error));
3345   }
3346 }
3347
3348
3349 /**
3350  * It is time to try to transmit a UDP message.  Select one
3351  * and send.
3352  *
3353  * @param plugin the plugin
3354  * @param sock which socket (v4/v6) to send on
3355  */
3356 static void
3357 udp_select_send (struct Plugin *plugin,
3358                  struct GNUNET_NETWORK_Handle *sock)
3359 {
3360   ssize_t sent;
3361   socklen_t slen;
3362   const struct sockaddr *a;
3363   const struct IPv4UdpAddress *u4;
3364   struct sockaddr_in a4;
3365   const struct IPv6UdpAddress *u6;
3366   struct sockaddr_in6 a6;
3367   struct UDP_MessageWrapper *udpw;
3368
3369   /* Find message(s) to send */
3370   while (NULL != (udpw = remove_timeout_messages_and_select (plugin,
3371                                                              sock)))
3372   {
3373     if (sizeof (struct IPv4UdpAddress) == udpw->session->address->address_length)
3374     {
3375       u4 = udpw->session->address->address;
3376       memset (&a4,
3377               0,
3378               sizeof(a4));
3379       a4.sin_family = AF_INET;
3380 #if HAVE_SOCKADDR_IN_SIN_LEN
3381       a4.sin_len = sizeof (a4);
3382 #endif
3383       a4.sin_port = u4->u4_port;
3384       a4.sin_addr.s_addr = u4->ipv4_addr;
3385       a = (const struct sockaddr *) &a4;
3386       slen = sizeof (a4);
3387     }
3388     else if (sizeof (struct IPv6UdpAddress) == udpw->session->address->address_length)
3389     {
3390       u6 = udpw->session->address->address;
3391       memset (&a6,
3392               0,
3393               sizeof(a6));
3394       a6.sin6_family = AF_INET6;
3395 #if HAVE_SOCKADDR_IN_SIN_LEN
3396       a6.sin6_len = sizeof (a6);
3397 #endif
3398       a6.sin6_port = u6->u6_port;
3399       a6.sin6_addr = u6->ipv6_addr;
3400       a = (const struct sockaddr *) &a6;
3401       slen = sizeof (a6);
3402     }
3403     else
3404     {
3405       GNUNET_break (0);
3406       dequeue (plugin,
3407                udpw);
3408       udpw->qc (udpw->qc_cls,
3409                 udpw,
3410                 GNUNET_SYSERR);
3411       notify_session_monitor (plugin,
3412                               udpw->session,
3413                               GNUNET_TRANSPORT_SS_UPDATE);
3414       GNUNET_free (udpw);
3415       continue;
3416     }
3417     sent = GNUNET_NETWORK_socket_sendto (sock,
3418                                          udpw->msg_buf,
3419                                          udpw->msg_size,
3420                                          a,
3421                                          slen);
3422     udpw->session->last_transmit_time
3423       = GNUNET_TIME_absolute_max (GNUNET_TIME_absolute_get (),
3424                                   udpw->session->last_transmit_time);
3425     dequeue (plugin,
3426              udpw);
3427     if (GNUNET_SYSERR == sent)
3428     {
3429       /* Failure */
3430       analyze_send_error (plugin,
3431                           a,
3432                           slen,
3433                           errno);
3434       udpw->qc (udpw->qc_cls,
3435                 udpw,
3436                 GNUNET_SYSERR);
3437       GNUNET_STATISTICS_update (plugin->env->stats,
3438                                 "# UDP, total, bytes, sent, failure",
3439                                 sent,
3440                                 GNUNET_NO);
3441       GNUNET_STATISTICS_update (plugin->env->stats,
3442                                 "# UDP, total, messages, sent, failure",
3443                                 1,
3444                                 GNUNET_NO);
3445     }
3446     else
3447     {
3448       /* Success */
3449       LOG (GNUNET_ERROR_TYPE_DEBUG,
3450            "UDP transmitted %u-byte message to  `%s' `%s' (%d: %s)\n",
3451            (unsigned int) (udpw->msg_size),
3452            GNUNET_i2s (&udpw->session->target),
3453            GNUNET_a2s (a,
3454                        slen),
3455            (int ) sent,
3456            (sent < 0) ? STRERROR (errno) : "ok");
3457       GNUNET_STATISTICS_update (plugin->env->stats,
3458                                 "# UDP, total, bytes, sent, success",
3459                                 sent,
3460                                 GNUNET_NO);
3461       GNUNET_STATISTICS_update (plugin->env->stats,
3462                                 "# UDP, total, messages, sent, success",
3463                                 1,
3464                                 GNUNET_NO);
3465       if (NULL != udpw->frag_ctx)
3466         udpw->frag_ctx->on_wire_size += udpw->msg_size;
3467       udpw->qc (udpw->qc_cls,
3468                 udpw,
3469                 GNUNET_OK);
3470     }
3471     notify_session_monitor (plugin,
3472                             udpw->session,
3473                             GNUNET_TRANSPORT_SS_UPDATE);
3474     GNUNET_free (udpw);
3475   }
3476 }
3477
3478
3479 /* ***************** Event loop (part 2) *************** */
3480
3481
3482 /**
3483  * We have been notified that our readset has something to read.  We don't
3484  * know which socket needs to be read, so we have to check each one
3485  * Then reschedule this function to be called again once more is available.
3486  *
3487  * @param cls the plugin handle
3488  * @param tc the scheduling context
3489  */
3490 static void
3491 udp_plugin_select_v4 (void *cls,
3492                       const struct GNUNET_SCHEDULER_TaskContext *tc)
3493 {
3494   struct Plugin *plugin = cls;
3495
3496   plugin->select_task_v4 = NULL;
3497   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
3498     return;
3499   if (NULL == plugin->sockv4)
3500     return;
3501   if ((0 != (tc->reason & GNUNET_SCHEDULER_REASON_READ_READY)) &&
3502       (GNUNET_NETWORK_fdset_isset (tc->read_ready,
3503                                    plugin->sockv4)))
3504     udp_select_read (plugin,
3505                      plugin->sockv4);
3506   udp_select_send (plugin,
3507                    plugin->sockv4);
3508   schedule_select_v4 (plugin);
3509 }
3510
3511
3512 /**
3513  * We have been notified that our readset has something to read.  We don't
3514  * know which socket needs to be read, so we have to check each one
3515  * Then reschedule this function to be called again once more is available.
3516  *
3517  * @param cls the plugin handle
3518  * @param tc the scheduling context
3519  */
3520 static void
3521 udp_plugin_select_v6 (void *cls,
3522                       const struct GNUNET_SCHEDULER_TaskContext *tc)
3523 {
3524   struct Plugin *plugin = cls;
3525
3526   plugin->select_task_v6 = NULL;
3527   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
3528     return;
3529   if (NULL == plugin->sockv6)
3530     return;
3531   if ( (0 != (tc->reason & GNUNET_SCHEDULER_REASON_READ_READY)) &&
3532        (GNUNET_NETWORK_fdset_isset (tc->read_ready,
3533                                     plugin->sockv6)) )
3534     udp_select_read (plugin,
3535                      plugin->sockv6);
3536
3537   udp_select_send (plugin,
3538                    plugin->sockv6);
3539   schedule_select_v6 (plugin);
3540 }
3541
3542
3543 /* ******************* Initialization *************** */
3544
3545
3546 /**
3547  * Setup the UDP sockets (for IPv4 and IPv6) for the plugin.
3548  *
3549  * @param plugin the plugin to initialize
3550  * @param bind_v6 IPv6 address to bind to (can be NULL, for 'any')
3551  * @param bind_v4 IPv4 address to bind to (can be NULL, for 'any')
3552  * @return number of sockets that were successfully bound
3553  */
3554 static int
3555 setup_sockets (struct Plugin *plugin,
3556                const struct sockaddr_in6 *bind_v6,
3557                const struct sockaddr_in *bind_v4)
3558 {
3559   int tries;
3560   int sockets_created = 0;
3561   struct sockaddr_in6 server_addrv6;
3562   struct sockaddr_in server_addrv4;
3563   const struct sockaddr *server_addr;
3564   const struct sockaddr *addrs[2];
3565   socklen_t addrlens[2];
3566   socklen_t addrlen;
3567   int eno;
3568
3569   /* Create IPv6 socket */
3570   eno = EINVAL;
3571   if (GNUNET_YES == plugin->enable_ipv6)
3572   {
3573     plugin->sockv6 = GNUNET_NETWORK_socket_create (PF_INET6,
3574                                                    SOCK_DGRAM,
3575                                                    0);
3576     if (NULL == plugin->sockv6)
3577     {
3578       LOG (GNUNET_ERROR_TYPE_INFO,
3579            _("Disabling IPv6 since it is not supported on this system!\n"));
3580       plugin->enable_ipv6 = GNUNET_NO;
3581     }
3582     else
3583     {
3584       memset (&server_addrv6,
3585               0,
3586               sizeof(struct sockaddr_in6));
3587 #if HAVE_SOCKADDR_IN_SIN_LEN
3588       server_addrv6.sin6_len = sizeof (struct sockaddr_in6);
3589 #endif
3590       server_addrv6.sin6_family = AF_INET6;
3591       if (NULL != bind_v6)
3592         server_addrv6.sin6_addr = bind_v6->sin6_addr;
3593       else
3594         server_addrv6.sin6_addr = in6addr_any;
3595
3596       if (0 == plugin->port) /* autodetect */
3597         server_addrv6.sin6_port
3598           = htons (GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_STRONG,
3599                                              33537)
3600                    + 32000);
3601       else
3602         server_addrv6.sin6_port = htons (plugin->port);
3603       addrlen = sizeof (struct sockaddr_in6);
3604       server_addr = (const struct sockaddr *) &server_addrv6;
3605
3606       tries = 0;
3607       while (tries < 10)
3608       {
3609         LOG(GNUNET_ERROR_TYPE_DEBUG,
3610             "Binding to IPv6 `%s'\n",
3611             GNUNET_a2s (server_addr,
3612                         addrlen));
3613         /* binding */
3614         if (GNUNET_OK ==
3615             GNUNET_NETWORK_socket_bind (plugin->sockv6,
3616                                         server_addr,
3617                                         addrlen))
3618           break;
3619         eno = errno;
3620         if (0 != plugin->port)
3621         {
3622           tries = 10; /* fail immediately */
3623           break; /* bind failed on specific port */
3624         }
3625         /* autodetect */
3626         server_addrv6.sin6_port
3627           = htons (GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_STRONG,
3628                                              33537)
3629                    + 32000);
3630         tries++;
3631       }
3632       if (tries >= 10)
3633       {
3634         GNUNET_NETWORK_socket_close (plugin->sockv6);
3635         plugin->enable_ipv6 = GNUNET_NO;
3636         plugin->sockv6 = NULL;
3637       }
3638       else
3639       {
3640         plugin->port = ntohs (server_addrv6.sin6_port);
3641       }
3642       if (NULL != plugin->sockv6)
3643       {
3644         LOG (GNUNET_ERROR_TYPE_DEBUG,
3645              "IPv6 UDP socket created listinging at %s\n",
3646              GNUNET_a2s (server_addr,
3647                          addrlen));
3648         addrs[sockets_created] = server_addr;
3649         addrlens[sockets_created] = addrlen;
3650         sockets_created++;
3651       }
3652       else
3653       {
3654         LOG (GNUNET_ERROR_TYPE_WARNING,
3655              _("Failed to bind UDP socket to %s: %s\n"),
3656              GNUNET_a2s (server_addr,
3657                          addrlen),
3658              STRERROR (eno));
3659       }
3660     }
3661   }
3662
3663   /* Create IPv4 socket */
3664   eno = EINVAL;
3665   plugin->sockv4 = GNUNET_NETWORK_socket_create (PF_INET,
3666                                                  SOCK_DGRAM,
3667                                                  0);
3668   if (NULL == plugin->sockv4)
3669   {
3670     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
3671                          "socket");
3672     LOG (GNUNET_ERROR_TYPE_INFO,
3673          _("Disabling IPv4 since it is not supported on this system!\n"));
3674     plugin->enable_ipv4 = GNUNET_NO;
3675   }
3676   else
3677   {
3678     memset (&server_addrv4,
3679             0,
3680             sizeof(struct sockaddr_in));
3681 #if HAVE_SOCKADDR_IN_SIN_LEN
3682     server_addrv4.sin_len = sizeof (struct sockaddr_in);
3683 #endif
3684     server_addrv4.sin_family = AF_INET;
3685     if (NULL != bind_v4)
3686       server_addrv4.sin_addr = bind_v4->sin_addr;
3687     else
3688       server_addrv4.sin_addr.s_addr = INADDR_ANY;
3689
3690     if (0 == plugin->port)
3691       /* autodetect */
3692       server_addrv4.sin_port
3693         = htons (GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_STRONG,
3694                                            33537)
3695                  + 32000);
3696     else
3697       server_addrv4.sin_port = htons (plugin->port);
3698
3699     addrlen = sizeof (struct sockaddr_in);
3700     server_addr = (const struct sockaddr *) &server_addrv4;
3701
3702     tries = 0;
3703     while (tries < 10)
3704     {
3705       LOG (GNUNET_ERROR_TYPE_DEBUG,
3706            "Binding to IPv4 `%s'\n",
3707            GNUNET_a2s (server_addr,
3708                        addrlen));
3709
3710       /* binding */
3711       if (GNUNET_OK ==
3712           GNUNET_NETWORK_socket_bind (plugin->sockv4,
3713                                       server_addr,
3714                                       addrlen))
3715         break;
3716       eno = errno;
3717       if (0 != plugin->port)
3718       {
3719         tries = 10; /* fail */
3720         break; /* bind failed on specific port */
3721       }
3722
3723       /* autodetect */
3724       server_addrv4.sin_port
3725         = htons (GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_STRONG,
3726                                            33537)
3727                  + 32000);
3728       tries++;
3729     }
3730     if (tries >= 10)
3731     {
3732       GNUNET_NETWORK_socket_close (plugin->sockv4);
3733       plugin->enable_ipv4 = GNUNET_NO;
3734       plugin->sockv4 = NULL;
3735     }
3736     else
3737     {
3738       plugin->port = ntohs (server_addrv4.sin_port);
3739     }
3740
3741     if (NULL != plugin->sockv4)
3742     {
3743       LOG (GNUNET_ERROR_TYPE_DEBUG,
3744            "IPv4 socket created on port %s\n",
3745            GNUNET_a2s (server_addr,
3746                        addrlen));
3747       addrs[sockets_created] = server_addr;
3748       addrlens[sockets_created] = addrlen;
3749       sockets_created++;
3750     }
3751     else
3752     {
3753       LOG (GNUNET_ERROR_TYPE_ERROR,
3754            _("Failed to bind UDP socket to %s: %s\n"),
3755            GNUNET_a2s (server_addr,
3756                        addrlen),
3757            STRERROR (eno));
3758     }
3759   }
3760
3761   if (0 == sockets_created)
3762   {
3763     LOG (GNUNET_ERROR_TYPE_WARNING,
3764          _("Failed to open UDP sockets\n"));
3765     return 0; /* No sockets created, return */
3766   }
3767   schedule_select_v4 (plugin);
3768   schedule_select_v6 (plugin);
3769   plugin->nat = GNUNET_NAT_register (plugin->env->cfg,
3770                                      GNUNET_NO,
3771                                      plugin->port,
3772                                      sockets_created,
3773                                      addrs,
3774                                      addrlens,
3775                                      &udp_nat_port_map_callback,
3776                                      NULL,
3777                                      plugin,
3778                                      plugin->sockv4);
3779   return sockets_created;
3780 }
3781
3782
3783 /**
3784  * The exported method. Makes the core api available via a global and
3785  * returns the udp transport API.
3786  *
3787  * @param cls our `struct GNUNET_TRANSPORT_PluginEnvironment`
3788  * @return our `struct GNUNET_TRANSPORT_PluginFunctions`
3789  */
3790 void *
3791 libgnunet_plugin_transport_udp_init (void *cls)
3792 {
3793   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
3794   struct GNUNET_TRANSPORT_PluginFunctions *api;
3795   struct Plugin *p;
3796   unsigned long long port;
3797   unsigned long long aport;
3798   unsigned long long udp_max_bps;
3799   unsigned long long enable_v6;
3800   unsigned long long enable_broadcasting;
3801   unsigned long long enable_broadcasting_recv;
3802   char *bind4_address;
3803   char *bind6_address;
3804   struct GNUNET_TIME_Relative interval;
3805   struct sockaddr_in server_addrv4;
3806   struct sockaddr_in6 server_addrv6;
3807   int res;
3808   int have_bind4;
3809   int have_bind6;
3810
3811   if (NULL == env->receive)
3812   {
3813     /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
3814      initialze the plugin or the API */
3815     api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
3816     api->cls = NULL;
3817     api->address_pretty_printer = &udp_plugin_address_pretty_printer;
3818     api->address_to_string = &udp_address_to_string;
3819     api->string_to_address = &udp_string_to_address;
3820     return api;
3821   }
3822
3823   /* Get port number: port == 0 : autodetect a port,
3824    * > 0 : use this port, not given : 2086 default */
3825   if (GNUNET_OK !=
3826       GNUNET_CONFIGURATION_get_value_number (env->cfg,
3827                                              "transport-udp",
3828                                              "PORT",
3829                                              &port))
3830     port = 2086;
3831   if (port > 65535)
3832   {
3833     GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
3834                                "transport-udp",
3835                                "PORT",
3836                                _("must be in [0,65535]"));
3837     return NULL;
3838   }
3839   if (GNUNET_OK !=
3840       GNUNET_CONFIGURATION_get_value_number (env->cfg,
3841                                              "transport-udp",
3842                                              "ADVERTISED_PORT",
3843                                              &aport))
3844     aport = port;
3845   if (aport > 65535)
3846   {
3847     GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
3848                                "transport-udp",
3849                                "ADVERTISED_PORT",
3850                                _("must be in [0,65535]"));
3851     return NULL;
3852   }
3853
3854   if (GNUNET_YES ==
3855       GNUNET_CONFIGURATION_get_value_yesno (env->cfg,
3856                                             "nat",
3857                                             "DISABLEV6"))
3858     enable_v6 = GNUNET_NO;
3859   else
3860     enable_v6 = GNUNET_YES;
3861
3862   have_bind4 = GNUNET_NO;
3863   memset (&server_addrv4,
3864           0,
3865           sizeof (server_addrv4));
3866   if (GNUNET_YES ==
3867       GNUNET_CONFIGURATION_get_value_string (env->cfg,
3868                                              "transport-udp",
3869                                              "BINDTO",
3870                                              &bind4_address))
3871   {
3872     LOG (GNUNET_ERROR_TYPE_DEBUG,
3873          "Binding UDP plugin to specific address: `%s'\n",
3874          bind4_address);
3875     if (1 != inet_pton (AF_INET,
3876                         bind4_address,
3877                         &server_addrv4.sin_addr))
3878     {
3879       GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
3880                                  "transport-udp",
3881                                  "BINDTO",
3882                                  _("must be valid IPv4 address"));
3883       GNUNET_free (bind4_address);
3884       return NULL;
3885     }
3886     have_bind4 = GNUNET_YES;
3887   }
3888   GNUNET_free_non_null (bind4_address);
3889   have_bind6 = GNUNET_NO;
3890   memset (&server_addrv6,
3891           0,
3892           sizeof (server_addrv6));
3893   if (GNUNET_YES ==
3894       GNUNET_CONFIGURATION_get_value_string (env->cfg,
3895                                              "transport-udp",
3896                                              "BINDTO6",
3897                                              &bind6_address))
3898   {
3899     LOG (GNUNET_ERROR_TYPE_DEBUG,
3900          "Binding udp plugin to specific address: `%s'\n",
3901          bind6_address);
3902     if (1 != inet_pton (AF_INET6,
3903                         bind6_address,
3904                         &server_addrv6.sin6_addr))
3905     {
3906       GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
3907                                  "transport-udp",
3908                                  "BINDTO6",
3909                                  _("must be valid IPv6 address"));
3910       GNUNET_free (bind6_address);
3911       return NULL;
3912     }
3913     have_bind6 = GNUNET_YES;
3914   }
3915   GNUNET_free_non_null (bind6_address);
3916
3917   enable_broadcasting = GNUNET_CONFIGURATION_get_value_yesno (env->cfg,
3918                                                               "transport-udp",
3919                                                               "BROADCAST");
3920   if (enable_broadcasting == GNUNET_SYSERR)
3921     enable_broadcasting = GNUNET_NO;
3922
3923   enable_broadcasting_recv = GNUNET_CONFIGURATION_get_value_yesno (env->cfg,
3924                                                                    "transport-udp",
3925                                                                    "BROADCAST_RECEIVE");
3926   if (enable_broadcasting_recv == GNUNET_SYSERR)
3927     enable_broadcasting_recv = GNUNET_YES;
3928
3929   if (GNUNET_SYSERR ==
3930       GNUNET_CONFIGURATION_get_value_time (env->cfg,
3931                                            "transport-udp",
3932                                            "BROADCAST_INTERVAL",
3933                                            &interval))
3934   {
3935     interval = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
3936                                               10);
3937   }
3938   if (GNUNET_OK !=
3939       GNUNET_CONFIGURATION_get_value_number (env->cfg,
3940                                              "transport-udp",
3941                                              "MAX_BPS",
3942                                              &udp_max_bps))
3943   {
3944     /* 50 MB/s == infinity for practical purposes */
3945     udp_max_bps = 1024 * 1024 * 50;
3946   }
3947
3948   p = GNUNET_new (struct Plugin);
3949   p->port = port;
3950   p->aport = aport;
3951   p->broadcast_interval = interval;
3952   p->enable_ipv6 = enable_v6;
3953   p->enable_ipv4 = GNUNET_YES; /* default */
3954   p->enable_broadcasting = enable_broadcasting;
3955   p->enable_broadcasting_receiving = enable_broadcasting_recv;
3956   p->env = env;
3957   p->sessions = GNUNET_CONTAINER_multipeermap_create (16,
3958                                                       GNUNET_NO);
3959   p->defrag_ctxs = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
3960   p->mst = GNUNET_SERVER_mst_create (&process_inbound_tokenized_messages,
3961                                      p);
3962   GNUNET_BANDWIDTH_tracker_init (&p->tracker,
3963                                  NULL,
3964                                  NULL,
3965                                  GNUNET_BANDWIDTH_value_init ((uint32_t) udp_max_bps),
3966                                  30);
3967   res = setup_sockets (p,
3968                        (GNUNET_YES == have_bind6) ? &server_addrv6 : NULL,
3969                        (GNUNET_YES == have_bind4) ? &server_addrv4 : NULL);
3970   if ( (0 == res) ||
3971        ( (NULL == p->sockv4) &&
3972          (NULL == p->sockv6) ) )
3973   {
3974     LOG (GNUNET_ERROR_TYPE_ERROR,
3975         _("Failed to create UDP network sockets\n"));
3976     GNUNET_CONTAINER_multipeermap_destroy (p->sessions);
3977     GNUNET_CONTAINER_heap_destroy (p->defrag_ctxs);
3978     GNUNET_SERVER_mst_destroy (p->mst);
3979     GNUNET_free (p);
3980     return NULL;
3981   }
3982
3983   /* Setup broadcasting and receiving beacons */
3984   setup_broadcast (p,
3985                    &server_addrv6,
3986                    &server_addrv4);
3987
3988   api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
3989   api->cls = p;
3990   api->disconnect_session = &udp_disconnect_session;
3991   api->query_keepalive_factor = &udp_query_keepalive_factor;
3992   api->disconnect_peer = &udp_disconnect;
3993   api->address_pretty_printer = &udp_plugin_address_pretty_printer;
3994   api->address_to_string = &udp_address_to_string;
3995   api->string_to_address = &udp_string_to_address;
3996   api->check_address = &udp_plugin_check_address;
3997   api->get_session = &udp_plugin_get_session;
3998   api->send = &udp_plugin_send;
3999   api->get_network = &udp_plugin_get_network;
4000   api->get_network_for_address = &udp_plugin_get_network_for_address;
4001   api->update_session_timeout = &udp_plugin_update_session_timeout;
4002   api->setup_monitor = &udp_plugin_setup_monitor;
4003   return api;
4004 }
4005
4006
4007 /**
4008  * Function called on each entry in the defragmentation heap to
4009  * clean it up.
4010  *
4011  * @param cls NULL
4012  * @param node node in the heap (to be removed)
4013  * @param element a `struct DefragContext` to be cleaned up
4014  * @param cost unused
4015  * @return #GNUNET_YES
4016  */
4017 static int
4018 heap_cleanup_iterator (void *cls,
4019                        struct GNUNET_CONTAINER_HeapNode *node,
4020                        void *element,
4021                        GNUNET_CONTAINER_HeapCostType cost)
4022 {
4023   struct DefragContext *d_ctx = element;
4024
4025   GNUNET_CONTAINER_heap_remove_node (node);
4026   GNUNET_DEFRAGMENT_context_destroy (d_ctx->defrag);
4027   GNUNET_free (d_ctx);
4028   return GNUNET_YES;
4029 }
4030
4031
4032 /**
4033  * The exported method. Makes the core api available via a global and
4034  * returns the udp transport API.
4035  *
4036  * @param cls our `struct GNUNET_TRANSPORT_PluginEnvironment`
4037  * @return NULL
4038  */
4039 void *
4040 libgnunet_plugin_transport_udp_done (void *cls)
4041 {
4042   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
4043   struct Plugin *plugin = api->cls;
4044   struct PrettyPrinterContext *cur;
4045   struct UDP_MessageWrapper *udpw;
4046
4047   if (NULL == plugin)
4048   {
4049     GNUNET_free (api);
4050     return NULL;
4051   }
4052   stop_broadcast (plugin);
4053   if (NULL != plugin->select_task_v4)
4054   {
4055     GNUNET_SCHEDULER_cancel (plugin->select_task_v4);
4056     plugin->select_task_v4 = NULL;
4057   }
4058   if (NULL != plugin->select_task_v6)
4059   {
4060     GNUNET_SCHEDULER_cancel (plugin->select_task_v6);
4061     plugin->select_task_v6 = NULL;
4062   }
4063   if (NULL != plugin->sockv4)
4064   {
4065     GNUNET_break (GNUNET_OK ==
4066                   GNUNET_NETWORK_socket_close (plugin->sockv4));
4067     plugin->sockv4 = NULL;
4068   }
4069   if (NULL != plugin->sockv6)
4070   {
4071     GNUNET_break (GNUNET_OK ==
4072                   GNUNET_NETWORK_socket_close (plugin->sockv6));
4073     plugin->sockv6 = NULL;
4074   }
4075   if (NULL != plugin->nat)
4076   {
4077     GNUNET_NAT_unregister (plugin->nat);
4078     plugin->nat = NULL;
4079   }
4080   if (NULL != plugin->defrag_ctxs)
4081   {
4082     GNUNET_CONTAINER_heap_iterate (plugin->defrag_ctxs,
4083                                    &heap_cleanup_iterator,
4084                                    NULL);
4085     GNUNET_CONTAINER_heap_destroy (plugin->defrag_ctxs);
4086     plugin->defrag_ctxs = NULL;
4087   }
4088   if (NULL != plugin->mst)
4089   {
4090     GNUNET_SERVER_mst_destroy (plugin->mst);
4091     plugin->mst = NULL;
4092   }
4093   while (NULL != (udpw = plugin->ipv4_queue_head))
4094   {
4095     dequeue (plugin,
4096              udpw);
4097     udpw->qc (udpw->qc_cls,
4098               udpw,
4099               GNUNET_SYSERR);
4100     GNUNET_free (udpw);
4101   }
4102   while (NULL != (udpw = plugin->ipv6_queue_head))
4103   {
4104     dequeue (plugin,
4105              udpw);
4106     udpw->qc (udpw->qc_cls,
4107               udpw,
4108               GNUNET_SYSERR);
4109     GNUNET_free (udpw);
4110   }
4111   GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
4112                                          &disconnect_and_free_it,
4113                                          plugin);
4114   GNUNET_CONTAINER_multipeermap_destroy (plugin->sessions);
4115
4116   while (NULL != (cur = plugin->ppc_dll_head))
4117   {
4118     GNUNET_break (0);
4119     GNUNET_CONTAINER_DLL_remove (plugin->ppc_dll_head,
4120                                  plugin->ppc_dll_tail,
4121                                  cur);
4122     GNUNET_RESOLVER_request_cancel (cur->resolver_handle);
4123     if (NULL != cur->timeout_task)
4124     {
4125       GNUNET_SCHEDULER_cancel (cur->timeout_task);
4126       cur->timeout_task = NULL;
4127     }
4128     GNUNET_free (cur);
4129   }
4130   GNUNET_free (plugin);
4131   GNUNET_free (api);
4132   return NULL;
4133 }
4134
4135 /* end of plugin_transport_udp.c */