Fix assertion failure seen on buildbot ubuntu-armv71-evans,
[oweals/gnunet.git] / src / transport / plugin_transport_tcp.c
1 /*
2      This file is part of GNUnet
3      (C) 2002--2013 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 3, or (at your
8      option) any later version.
9
10      GNUnet is distributed in the hope that it will be useful, but
11      WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20 /**
21  * @file transport/plugin_transport_tcp.c
22  * @brief Implementation of the TCP transport service
23  * @author Christian Grothoff
24  */
25 #include "platform.h"
26 #include "gnunet_hello_lib.h"
27 #include "gnunet_constants.h"
28 #include "gnunet_util_lib.h"
29 #include "gnunet_nat_lib.h"
30 #include "gnunet_protocols.h"
31 #include "gnunet_resolver_service.h"
32 #include "gnunet_signatures.h"
33 #include "gnunet_statistics_service.h"
34 #include "gnunet_transport_service.h"
35 #include "gnunet_transport_plugin.h"
36 #include "transport.h"
37
38 #define LOG(kind,...) GNUNET_log_from (kind, "transport-tcp",__VA_ARGS__)
39
40 #define PLUGIN_NAME "tcp"
41
42 #define EXTRA_CHECKS ALLOW_EXTRA_CHECKS
43
44 /**
45  * How long until we give up on establishing an NAT connection?
46  * Must be > 4 RTT
47  */
48 #define NAT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
49
50
51 GNUNET_NETWORK_STRUCT_BEGIN
52
53 /**
54  * Address options
55  */
56 static uint32_t myoptions;
57
58 /**
59  * Initial handshake message for a session.
60  */
61 struct WelcomeMessage
62 {
63   /**
64    * Type is GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME.
65    */
66   struct GNUNET_MessageHeader header;
67
68   /**
69    * Identity of the node connecting (TCP client)
70    */
71   struct GNUNET_PeerIdentity clientIdentity;
72
73 };
74
75
76 /**
77  * Basically a WELCOME message, but with the purpose
78  * of giving the waiting peer a client handle to use
79  */
80 struct TCP_NAT_ProbeMessage
81 {
82   /**
83    * Type is GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE.
84    */
85   struct GNUNET_MessageHeader header;
86
87   /**
88    * Identity of the sender of the message.
89    */
90   struct GNUNET_PeerIdentity clientIdentity;
91
92 };
93 GNUNET_NETWORK_STRUCT_END
94
95 /**
96  * Context for sending a NAT probe via TCP.
97  */
98 struct TCPProbeContext
99 {
100
101   /**
102    * Active probes are kept in a DLL.
103    */
104   struct TCPProbeContext *next;
105
106   /**
107    * Active probes are kept in a DLL.
108    */
109   struct TCPProbeContext *prev;
110
111   /**
112    * Probe connection.
113    */
114   struct GNUNET_CONNECTION_Handle *sock;
115
116   /**
117    * Message to be sent.
118    */
119   struct TCP_NAT_ProbeMessage message;
120
121   /**
122    * Handle to the transmission.
123    */
124   struct GNUNET_CONNECTION_TransmitHandle *transmit_handle;
125
126   /**
127    * Transport plugin handle.
128    */
129   struct Plugin *plugin;
130 };
131
132
133 GNUNET_NETWORK_STRUCT_BEGIN
134
135 /**
136  * Network format for IPv4 addresses.
137  */
138 struct IPv4TcpAddress
139 {
140   /**
141    * Optional options and flags for this address
142    */
143   uint32_t options;
144
145   /**
146    * IPv4 address, in network byte order.
147    */
148   uint32_t ipv4_addr GNUNET_PACKED;
149
150   /**
151    * Port number, in network byte order.
152    */
153   uint16_t t4_port GNUNET_PACKED;
154
155 };
156
157
158 /**
159  * Network format for IPv6 addresses.
160  */
161 struct IPv6TcpAddress
162 {
163   /**
164    * Optional flags for this address
165    */
166   uint32_t options;
167
168   /**
169    * IPv6 address.
170    */
171   struct in6_addr ipv6_addr GNUNET_PACKED;
172
173   /**
174    * Port number, in network byte order.
175    */
176   uint16_t t6_port GNUNET_PACKED;
177
178 };
179 GNUNET_NETWORK_STRUCT_END
180
181 /**
182  * Encapsulation of all of the state of the plugin.
183  */
184 struct Plugin;
185
186
187 /**
188  * Information kept for each message that is yet to
189  * be transmitted.
190  */
191 struct PendingMessage
192 {
193
194   /**
195    * This is a doubly-linked list.
196    */
197   struct PendingMessage *next;
198
199   /**
200    * This is a doubly-linked list.
201    */
202   struct PendingMessage *prev;
203
204   /**
205    * The pending message
206    */
207   const char *msg;
208
209   /**
210    * Continuation function to call once the message
211    * has been sent.  Can be NULL if there is no
212    * continuation to call.
213    */
214   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
215
216   /**
217    * Closure for transmit_cont.
218    */
219   void *transmit_cont_cls;
220
221   /**
222    * Timeout value for the pending message.
223    */
224   struct GNUNET_TIME_Absolute timeout;
225
226   /**
227    * So that the gnunet-service-transport can group messages together,
228    * these pending messages need to accept a message buffer and size
229    * instead of just a GNUNET_MessageHeader.
230    */
231   size_t message_size;
232
233 };
234
235
236 /**
237  * Session handle for TCP connections.
238  */
239 struct Session
240 {
241   /**
242    * To whom are we talking to (set to our identity
243    * if we are still waiting for the welcome message)
244    */
245   struct GNUNET_PeerIdentity target;
246
247   /**
248    * API requirement.
249    */
250   struct SessionHeader header;
251
252   /**
253    * Pointer to the global plugin struct.
254    */
255   struct Plugin *plugin;
256
257   /**
258    * The client (used to identify this connection)
259    */
260   struct GNUNET_SERVER_Client *client;
261
262   /**
263    * Task cleaning up a NAT client connection establishment attempt;
264    */
265   GNUNET_SCHEDULER_TaskIdentifier nat_connection_timeout;
266
267   /**
268    * Messages currently pending for transmission
269    * to this peer, if any.
270    */
271   struct PendingMessage *pending_messages_head;
272
273   /**
274    * Messages currently pending for transmission
275    * to this peer, if any.
276    */
277   struct PendingMessage *pending_messages_tail;
278
279   /**
280    * Handle for pending transmission request.
281    */
282   struct GNUNET_SERVER_TransmitHandle *transmit_handle;
283
284   /**
285    * ID of task used to delay receiving more to throttle sender.
286    */
287   GNUNET_SCHEDULER_TaskIdentifier receive_delay_task;
288
289   /**
290    * Session timeout task
291    */
292   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
293
294   /**
295    * Address of the other peer (either based on our 'connect'
296    * call or on our 'accept' call).
297    *
298    * struct IPv4TcpAddress or struct IPv6TcpAddress
299    */
300   void *addr;
301
302   /**
303    * Length of @e addr.
304    */
305   size_t addrlen;
306
307   /**
308    * Last activity on this connection.  Used to select preferred
309    * connection.
310    */
311   struct GNUNET_TIME_Absolute last_activity;
312
313   /**
314    * Are we still expecting the welcome message? (#GNUNET_YES/#GNUNET_NO)
315    */
316   int expecting_welcome;
317
318   /**
319    * Was this a connection that was inbound (we accepted)? (#GNUNET_YES/#GNUNET_NO)
320    */
321   int inbound;
322
323   /**
324    * Was this session created using NAT traversal?
325    */
326   int is_nat;
327
328   /**
329    * ATS network type in NBO
330    */
331   enum GNUNET_ATS_Network_Type ats_address_network_type;
332 };
333
334
335 /**
336  * Encapsulation of all of the state of the plugin.
337  */
338 struct Plugin
339 {
340   /**
341    * Our environment.
342    */
343   struct GNUNET_TRANSPORT_PluginEnvironment *env;
344
345   /**
346    * The listen socket.
347    */
348   struct GNUNET_CONNECTION_Handle *lsock;
349
350   /**
351    * Our handle to the NAT module.
352    */
353   struct GNUNET_NAT_Handle *nat;
354
355   /**
356    * Map from peer identities to sessions for the given peer.
357    */
358   struct GNUNET_CONTAINER_MultiPeerMap *sessionmap;
359
360   /**
361    * Handle to the network service.
362    */
363   struct GNUNET_SERVICE_Context *service;
364
365   /**
366    * Handle to the server for this service.
367    */
368   struct GNUNET_SERVER_Handle *server;
369
370   /**
371    * Copy of the handler array where the closures are
372    * set to this struct's instance.
373    */
374   struct GNUNET_SERVER_MessageHandler *handlers;
375
376   /**
377    * Map of peers we have tried to contact behind a NAT
378    */
379   struct GNUNET_CONTAINER_MultiPeerMap *nat_wait_conns;
380
381   /**
382    * List of active TCP probes.
383    */
384   struct TCPProbeContext *probe_head;
385
386   /**
387    * List of active TCP probes.
388    */
389   struct TCPProbeContext *probe_tail;
390
391   /**
392    * Handle for (DYN)DNS lookup of our external IP.
393    */
394   struct GNUNET_RESOLVER_RequestHandle *ext_dns;
395
396   /**
397    * How many more TCP sessions are we allowed to open right now?
398    */
399   unsigned long long max_connections;
400
401   /**
402    * How many more TCP sessions do we have right now?
403    */
404   unsigned long long cur_connections;
405
406   /**
407    * ID of task used to update our addresses when one expires.
408    */
409   GNUNET_SCHEDULER_TaskIdentifier address_update_task;
410
411   /**
412    * Port that we are actually listening on.
413    */
414   uint16_t open_port;
415
416   /**
417    * Port that the user said we would have visible to the
418    * rest of the world.
419    */
420   uint16_t adv_port;
421
422 };
423
424
425 /**
426  * Function called for a quick conversion of the binary address to
427  * a numeric address.  Note that the caller must not free the
428  * address and that the next call to this function is allowed
429  * to override the address again.
430  *
431  * @param cls closure ('struct Plugin*')
432  * @param addr binary address
433  * @param addrlen length of the address
434  * @return string representing the same address
435  */
436 static const char *
437 tcp_address_to_string (void *cls,
438                        const void *addr,
439                        size_t addrlen);
440
441
442 /**
443  * Function to check if an inbound connection is acceptable.
444  * Mostly used to limit the total number of open connections
445  * we can have.
446  *
447  * @param cls the `struct Plugin`
448  * @param ucred credentials, if available, otherwise NULL
449  * @param addr address
450  * @param addrlen length of address
451  * @return #GNUNET_YES to allow, #GNUNET_NO to deny, #GNUNET_SYSERR
452  *   for unknown address family (will be denied).
453  */
454 static int
455 plugin_tcp_access_check (void *cls,
456                          const struct GNUNET_CONNECTION_Credentials *ucred,
457                          const struct sockaddr *addr, socklen_t addrlen)
458 {
459   struct Plugin *plugin = cls;
460   LOG (GNUNET_ERROR_TYPE_DEBUG,
461        "Accepting new incoming TCP connection from `%s'\n",
462        GNUNET_a2s (addr, addrlen));
463   if (plugin->cur_connections >= plugin->max_connections)
464     return GNUNET_NO;
465   plugin->cur_connections ++;
466   return GNUNET_YES;
467 }
468
469
470 /**
471  * Our external IP address/port mapping has changed.
472  *
473  * @param cls closure, the 'struct Plugin'
474  * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
475  *     the previous (now invalid) one
476  * @param addr either the previous or the new public IP address
477  * @param addrlen actual lenght of the address
478  */
479 static void
480 tcp_nat_port_map_callback (void *cls, int add_remove,
481                            const struct sockaddr *addr,
482                            socklen_t addrlen)
483 {
484   struct Plugin *plugin = cls;
485   struct IPv4TcpAddress t4;
486   struct IPv6TcpAddress t6;
487   void *arg;
488   size_t args;
489
490   LOG (GNUNET_ERROR_TYPE_INFO,
491        "NAT notification to %s address `%s'\n",
492        (GNUNET_YES == add_remove) ? "add" : "remove",
493        GNUNET_a2s (addr, addrlen));
494   /* convert 'addr' to our internal format */
495   switch (addr->sa_family)
496   {
497   case AF_INET:
498     GNUNET_assert (addrlen == sizeof (struct sockaddr_in));
499     memset (&t4,0, sizeof (t4));
500     t4.options = htonl (myoptions);
501     t4.ipv4_addr = ((struct sockaddr_in *) addr)->sin_addr.s_addr;
502     t4.t4_port = ((struct sockaddr_in *) addr)->sin_port;
503     arg = &t4;
504     args = sizeof (t4);
505     break;
506   case AF_INET6:
507     GNUNET_assert (addrlen == sizeof (struct sockaddr_in6));
508     memset (&t6, 0, sizeof (t6));
509     memcpy (&t6.ipv6_addr, &((struct sockaddr_in6 *) addr)->sin6_addr,
510             sizeof (struct in6_addr));
511     t6.options = htonl (myoptions);
512     t6.t6_port = ((struct sockaddr_in6 *) addr)->sin6_port;
513     arg = &t6;
514     args = sizeof (t6);
515     break;
516   default:
517     GNUNET_break (0);
518     return;
519   }
520   /* modify our published address list */
521   plugin->env->notify_address (plugin->env->cls, add_remove, arg, args, "tcp");
522 }
523
524
525 /**
526  * Function called for a quick conversion of the binary address to
527  * a numeric address.  Note that the caller must not free the
528  * address and that the next call to this function is allowed
529  * to override the address again.
530  *
531  * @param cls closure (`struct Plugin*`)
532  * @param addr binary address
533  * @param addrlen length of the address
534  * @return string representing the same address
535  */
536 static const char *
537 tcp_address_to_string (void *cls, const void *addr, size_t addrlen)
538 {
539   static char rbuf[INET6_ADDRSTRLEN + 12];
540   char buf[INET6_ADDRSTRLEN];
541   const void *sb;
542   struct in_addr a4;
543   struct in6_addr a6;
544   const struct IPv4TcpAddress *t4;
545   const struct IPv6TcpAddress *t6;
546   int af;
547   uint16_t port;
548   uint32_t options;
549
550   switch (addrlen)
551   {
552   case sizeof (struct IPv6TcpAddress):
553     t6 = addr;
554     af = AF_INET6;
555     port = ntohs (t6->t6_port);
556     options = ntohl (t6->options);
557     memcpy (&a6, &t6->ipv6_addr, sizeof (a6));
558     sb = &a6;
559     break;
560   case sizeof (struct IPv4TcpAddress):
561     t4 = addr;
562     af = AF_INET;
563     port = ntohs (t4->t4_port);
564     options = ntohl (t4->options);
565     memcpy (&a4, &t4->ipv4_addr, sizeof (a4));
566     sb = &a4;
567     break;
568   case 0:
569     {
570       GNUNET_snprintf (rbuf, sizeof (rbuf), "%s",
571                 TRANSPORT_SESSION_INBOUND_STRING);
572       return rbuf;
573     }
574   default:
575     LOG (GNUNET_ERROR_TYPE_WARNING,
576                 _("Unexpected address length: %u bytes\n"),
577                 (unsigned int) addrlen);
578     return NULL;
579   }
580   if (NULL == inet_ntop (af, sb, buf, INET6_ADDRSTRLEN))
581   {
582     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "inet_ntop");
583     return NULL;
584   }
585   GNUNET_snprintf (rbuf,
586                    sizeof (rbuf),
587                    (af == AF_INET6)
588                    ? "%s.%u.[%s]:%u"
589                    : "%s.%u.%s:%u",
590                    PLUGIN_NAME,
591                    options,
592                    buf,
593                    port);
594   return rbuf;
595 }
596
597
598 /**
599  * Function called to convert a string address to
600  * a binary address.
601  *
602  * @param cls closure (`struct Plugin*`)
603  * @param addr string address
604  * @param addrlen length of the address
605  * @param buf location to store the buffer
606  * @param added location to store the number of bytes in the buffer.
607  *        If the function returns #GNUNET_SYSERR, its contents are undefined.
608  * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
609  */
610 static int
611 tcp_string_to_address (void *cls,
612                        const char *addr,
613                        uint16_t addrlen,
614                        void **buf, size_t *added)
615 {
616   struct sockaddr_storage socket_address;
617   char *address;
618   char *plugin;
619   char *optionstr;
620   uint32_t options;
621
622   /* Format tcp.options.address:port */
623   address = NULL;
624   plugin = NULL;
625   optionstr = NULL;
626   if ((NULL == addr) || (addrlen == 0))
627   {
628     GNUNET_break (0);
629     return GNUNET_SYSERR;
630   }
631   if ('\0' != addr[addrlen - 1])
632   {
633     GNUNET_break (0);
634     return GNUNET_SYSERR;
635   }
636   if (strlen (addr) != addrlen - 1)
637   {
638     GNUNET_break (0);
639     return GNUNET_SYSERR;
640   }
641   plugin = GNUNET_strdup (addr);
642   optionstr = strchr (plugin, '.');
643   if (NULL == optionstr)
644   {
645     GNUNET_break (0);
646     GNUNET_free (plugin);
647     return GNUNET_SYSERR;
648   }
649   optionstr[0] = '\0';
650   optionstr ++;
651   options = atol (optionstr);
652   address = strchr (optionstr, '.');
653   if (NULL == address)
654   {
655     GNUNET_break (0);
656     GNUNET_free (plugin);
657     return GNUNET_SYSERR;
658   }
659   address[0] = '\0';
660   address ++;
661
662   if (GNUNET_OK !=
663       GNUNET_STRINGS_to_address_ip (address, strlen (address),
664                                     &socket_address))
665   {
666     GNUNET_break (0);
667     GNUNET_free (plugin);
668     return GNUNET_SYSERR;
669   }
670
671   GNUNET_free (plugin);
672   switch (socket_address.ss_family)
673   {
674   case AF_INET:
675     {
676       struct IPv4TcpAddress *t4;
677       struct sockaddr_in *in4 = (struct sockaddr_in *) &socket_address;
678       t4 = GNUNET_new (struct IPv4TcpAddress);
679       t4->options =  htonl (options);
680       t4->ipv4_addr = in4->sin_addr.s_addr;
681       t4->t4_port = in4->sin_port;
682       *buf = t4;
683       *added = sizeof (struct IPv4TcpAddress);
684       return GNUNET_OK;
685     }
686   case AF_INET6:
687     {
688       struct IPv6TcpAddress *t6;
689       struct sockaddr_in6 *in6 = (struct sockaddr_in6 *) &socket_address;
690       t6 = GNUNET_new (struct IPv6TcpAddress);
691       t6->options = htonl (options);
692       t6->ipv6_addr = in6->sin6_addr;
693       t6->t6_port = in6->sin6_port;
694       *buf = t6;
695       *added = sizeof (struct IPv6TcpAddress);
696       return GNUNET_OK;
697     }
698   default:
699     return GNUNET_SYSERR;
700   }
701 }
702
703
704 /**
705  * Closure for #session_lookup_by_client_it().
706  */
707 struct SessionClientCtx
708 {
709   /**
710    * Client we are looking for.
711    */
712   const struct GNUNET_SERVER_Client *client;
713
714   /**
715    * Session that was found.
716    */
717   struct Session *ret;
718 };
719
720
721 static int
722 session_lookup_by_client_it (void *cls,
723                              const struct GNUNET_PeerIdentity *key,
724                              void *value)
725 {
726   struct SessionClientCtx *sc_ctx = cls;
727   struct Session *s = value;
728
729   if (s->client == sc_ctx->client)
730   {
731     sc_ctx->ret = s;
732     return GNUNET_NO;
733   }
734   return GNUNET_YES;
735 }
736
737
738 /**
739  * Find the session handle for the given client.
740  * Currently uses both the hashmap and the client
741  * context, as the client context is new and the
742  * logic still needs to be tested.
743  *
744  * @param plugin the plugin
745  * @param client which client to find the session handle for
746  * @return NULL if no matching session exists
747  */
748 static struct Session *
749 lookup_session_by_client (struct Plugin *plugin,
750                           struct GNUNET_SERVER_Client *client)
751 {
752   struct Session *ret;
753   struct SessionClientCtx sc_ctx;
754
755   ret = GNUNET_SERVER_client_get_user_context (client, struct Session);
756   sc_ctx.client = client;
757   sc_ctx.ret = NULL;
758   GNUNET_CONTAINER_multipeermap_iterate (plugin->sessionmap,
759                                          &session_lookup_by_client_it, &sc_ctx);
760   /* check both methods yield the same result */
761   GNUNET_break (ret == sc_ctx.ret);
762   return sc_ctx.ret;
763 }
764
765
766 /**
767  * Functions with this signature are called whenever we need
768  * to close a session due to a disconnect or failure to
769  * establish a connection.
770  *
771  * @param cls the `struct Plugin`
772  * @param session session to close down
773  * @return #GNUNET_OK on success
774  */
775 static int
776 tcp_disconnect_session (void *cls,
777                         struct Session *session)
778 {
779   struct Plugin *plugin = cls;
780   struct PendingMessage *pm;
781
782   LOG (GNUNET_ERROR_TYPE_DEBUG,
783        "Disconnecting session of peer `%s' address `%s'\n",
784        GNUNET_i2s (&session->target),
785        tcp_address_to_string (NULL, session->addr, session->addrlen));
786
787   if (GNUNET_SCHEDULER_NO_TASK != session->timeout_task)
788   {
789     GNUNET_SCHEDULER_cancel (session->timeout_task);
790     session->timeout_task = GNUNET_SCHEDULER_NO_TASK;
791   }
792
793   if (GNUNET_YES ==
794       GNUNET_CONTAINER_multipeermap_remove (plugin->sessionmap,
795                                             &session->target,
796                                             session))
797   {
798     GNUNET_STATISTICS_update (session->plugin->env->stats,
799                               gettext_noop ("# TCP sessions active"), -1,
800                               GNUNET_NO);
801   }
802   else
803   {
804     GNUNET_assert (GNUNET_YES ==
805                    GNUNET_CONTAINER_multipeermap_remove (plugin->nat_wait_conns,
806                                                          &session->target,
807                                                          session));
808   }
809   GNUNET_SERVER_client_set_user_context (session->client,
810                                          (void *) NULL);
811
812   /* clean up state */
813   if (NULL != session->transmit_handle)
814   {
815     GNUNET_SERVER_notify_transmit_ready_cancel (session->transmit_handle);
816     session->transmit_handle = NULL;
817   }
818   session->plugin->env->session_end (session->plugin->env->cls,
819                                      &session->target, session);
820
821   if (GNUNET_SCHEDULER_NO_TASK != session->nat_connection_timeout)
822   {
823     GNUNET_SCHEDULER_cancel (session->nat_connection_timeout);
824     session->nat_connection_timeout = GNUNET_SCHEDULER_NO_TASK;
825   }
826
827   while (NULL != (pm = session->pending_messages_head))
828   {
829     LOG (GNUNET_ERROR_TYPE_DEBUG,
830          pm->transmit_cont !=
831          NULL ? "Could not deliver message to `%4s'.\n" :
832          "Could not deliver message to `%4s', notifying.\n",
833          GNUNET_i2s (&session->target));
834     GNUNET_STATISTICS_update (session->plugin->env->stats,
835                               gettext_noop ("# bytes currently in TCP buffers"),
836                               -(int64_t) pm->message_size, GNUNET_NO);
837     GNUNET_STATISTICS_update (session->plugin->env->stats,
838                               gettext_noop
839                               ("# bytes discarded by TCP (disconnect)"),
840                               pm->message_size, GNUNET_NO);
841     GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
842                                  session->pending_messages_tail, pm);
843     if (NULL != pm->transmit_cont)
844       pm->transmit_cont (pm->transmit_cont_cls, &session->target,
845                          GNUNET_SYSERR, pm->message_size, 0);
846     GNUNET_free (pm);
847   }
848   if (session->receive_delay_task != GNUNET_SCHEDULER_NO_TASK)
849   {
850     GNUNET_SCHEDULER_cancel (session->receive_delay_task);
851     if (NULL != session->client)
852       GNUNET_SERVER_receive_done (session->client, GNUNET_SYSERR);
853   }
854   if (NULL != session->client)
855   {
856     GNUNET_SERVER_client_disconnect (session->client);
857     GNUNET_SERVER_client_drop (session->client);
858     session->client = NULL;
859   }
860   GNUNET_free_non_null (session->addr);
861   GNUNET_assert (NULL == session->transmit_handle);
862   GNUNET_free (session);
863   return GNUNET_OK;
864 }
865
866
867 /**
868  * Function that is called to get the keepalive factor.
869  * GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
870  * calculate the interval between keepalive packets.
871  *
872  * @param cls closure with the `struct Plugin`
873  * @return keepalive factor
874  */
875 static unsigned int
876 tcp_query_keepalive_factor (void *cls)
877 {
878   return 3;
879 }
880
881
882 /**
883  * Session was idle, so disconnect it
884  *
885  * @param cls the `struct Session` of the idle session
886  * @param tc scheduler context
887  */
888 static void
889 session_timeout (void *cls,
890                  const struct GNUNET_SCHEDULER_TaskContext *tc)
891 {
892   struct Session *s = cls;
893
894   s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
895   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
896               "Session %p was idle for %s, disconnecting\n",
897               s,
898               GNUNET_STRINGS_relative_time_to_string (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
899                                                       GNUNET_YES));
900   /* call session destroy function */
901   tcp_disconnect_session (s->plugin, s);
902 }
903
904
905 /**
906  * Increment session timeout due to activity
907  *
908  * @param s session to increment timeout for
909  */
910 static void
911 reschedule_session_timeout (struct Session *s)
912 {
913   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != s->timeout_task);
914   GNUNET_SCHEDULER_cancel (s->timeout_task);
915   s->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
916                                                   &session_timeout,
917                                                   s);
918   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
919               "Timeout rescheduled for session %p set to %s\n",
920               s,
921               GNUNET_STRINGS_relative_time_to_string (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
922                                                       GNUNET_YES));
923 }
924
925
926 /**
927  * Create a new session.  Also queues a welcome message.
928  *
929  * @param plugin the plugin
930  * @param target peer to connect to
931  * @param client client to use, reference counter must have already been increased
932  * @param is_nat this a NAT session, we should wait for a client to
933  *               connect to us from an address, then assign that to
934  *               the session
935  * @return new session object
936  */
937 static struct Session *
938 create_session (struct Plugin *plugin,
939                 const struct GNUNET_PeerIdentity *target,
940                 struct GNUNET_SERVER_Client *client, int is_nat)
941 {
942   struct Session *session;
943   struct PendingMessage *pm;
944   struct WelcomeMessage welcome;
945
946   if (GNUNET_YES != is_nat)
947     GNUNET_assert (NULL != client);
948   else
949     GNUNET_assert (NULL == client);
950
951   LOG (GNUNET_ERROR_TYPE_DEBUG,
952        "Creating new session for peer `%4s'\n",
953        GNUNET_i2s (target));
954   session = GNUNET_new (struct Session);
955   session->last_activity = GNUNET_TIME_absolute_get ();
956   session->plugin = plugin;
957   session->is_nat = is_nat;
958   session->client = client;
959   session->target = *target;
960   session->expecting_welcome = GNUNET_YES;
961   session->ats_address_network_type = GNUNET_ATS_NET_UNSPECIFIED;
962   pm = GNUNET_malloc (sizeof (struct PendingMessage) +
963                       sizeof (struct WelcomeMessage));
964   pm->msg = (const char *) &pm[1];
965   pm->message_size = sizeof (struct WelcomeMessage);
966   welcome.header.size = htons (sizeof (struct WelcomeMessage));
967   welcome.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME);
968   welcome.clientIdentity = *plugin->env->my_identity;
969   memcpy (&pm[1], &welcome, sizeof (welcome));
970   pm->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
971   GNUNET_STATISTICS_update (plugin->env->stats,
972                             gettext_noop ("# bytes currently in TCP buffers"),
973                             pm->message_size, GNUNET_NO);
974   GNUNET_CONTAINER_DLL_insert (session->pending_messages_head,
975                                session->pending_messages_tail, pm);
976   if (GNUNET_YES != is_nat)
977   {
978     GNUNET_STATISTICS_update (plugin->env->stats,
979                               gettext_noop ("# TCP sessions active"), 1,
980                               GNUNET_NO);
981   }
982   session->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
983                                                         &session_timeout,
984                                                         session);
985   return session;
986 }
987
988
989 /**
990  * If we have pending messages, ask the server to
991  * transmit them (schedule the respective tasks, etc.)
992  *
993  * @param session for which session should we do this
994  */
995 static void
996 process_pending_messages (struct Session *session);
997
998
999 /**
1000  * Function called to notify a client about the socket
1001  * being ready to queue more data.  "buf" will be
1002  * NULL and "size" zero if the socket was closed for
1003  * writing in the meantime.
1004  *
1005  * @param cls closure
1006  * @param size number of bytes available in buf
1007  * @param buf where the callee should write the message
1008  * @return number of bytes written to buf
1009  */
1010 static size_t
1011 do_transmit (void *cls, size_t size, void *buf)
1012 {
1013   struct Session *session = cls;
1014   struct GNUNET_PeerIdentity pid;
1015   struct Plugin *plugin;
1016   struct PendingMessage *pos;
1017   struct PendingMessage *hd;
1018   struct PendingMessage *tl;
1019   struct GNUNET_TIME_Absolute now;
1020   char *cbuf;
1021   size_t ret;
1022
1023   GNUNET_assert (NULL != session);
1024   session->transmit_handle = NULL;
1025   plugin = session->plugin;
1026   if (NULL == buf)
1027   {
1028     LOG (GNUNET_ERROR_TYPE_DEBUG,
1029          "Timeout trying to transmit to peer `%4s', discarding message queue.\n",
1030          GNUNET_i2s (&session->target));
1031     /* timeout; cancel all messages that have already expired */
1032     hd = NULL;
1033     tl = NULL;
1034     ret = 0;
1035     now = GNUNET_TIME_absolute_get ();
1036     while ((NULL != (pos = session->pending_messages_head)) &&
1037            (pos->timeout.abs_value_us <= now.abs_value_us))
1038     {
1039       GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
1040                                    session->pending_messages_tail, pos);
1041       LOG (GNUNET_ERROR_TYPE_DEBUG,
1042            "Failed to transmit %u byte message to `%4s'.\n",
1043            pos->message_size, GNUNET_i2s (&session->target));
1044       ret += pos->message_size;
1045       GNUNET_CONTAINER_DLL_insert_after (hd, tl, tl, pos);
1046     }
1047     /* do this call before callbacks (so that if callbacks destroy
1048      * session, they have a chance to cancel actions done by this
1049      * call) */
1050     process_pending_messages (session);
1051     pid = session->target;
1052     /* no do callbacks and do not use session again since
1053      * the callbacks may abort the session */
1054     while (NULL != (pos = hd))
1055     {
1056       GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
1057       if (pos->transmit_cont != NULL)
1058         pos->transmit_cont (pos->transmit_cont_cls, &pid, GNUNET_SYSERR, pos->message_size, 0);
1059       GNUNET_free (pos);
1060     }
1061     GNUNET_STATISTICS_update (plugin->env->stats,
1062                               gettext_noop ("# bytes currently in TCP buffers"),
1063                               -(int64_t) ret, GNUNET_NO);
1064     GNUNET_STATISTICS_update (plugin->env->stats,
1065                               gettext_noop
1066                               ("# bytes discarded by TCP (timeout)"), ret,
1067                               GNUNET_NO);
1068     return 0;
1069   }
1070   /* copy all pending messages that would fit */
1071   ret = 0;
1072   cbuf = buf;
1073   hd = NULL;
1074   tl = NULL;
1075   while (NULL != (pos = session->pending_messages_head))
1076   {
1077     if (ret + pos->message_size > size)
1078       break;
1079     GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
1080                                  session->pending_messages_tail, pos);
1081     GNUNET_assert (size >= pos->message_size);
1082     LOG (GNUNET_ERROR_TYPE_DEBUG,
1083          "Transmitting message of type %u\n",
1084          ntohs (((struct GNUNET_MessageHeader *) pos->msg)->type));
1085     /* FIXME: this memcpy can be up to 7% of our total runtime */
1086     memcpy (cbuf, pos->msg, pos->message_size);
1087     cbuf += pos->message_size;
1088     ret += pos->message_size;
1089     size -= pos->message_size;
1090     GNUNET_CONTAINER_DLL_insert_tail (hd, tl, pos);
1091   }
1092   /* schedule 'continuation' before callbacks so that callbacks that
1093    * cancel everything don't cause us to use a session that no longer
1094    * exists... */
1095   process_pending_messages (session);
1096   session->last_activity = GNUNET_TIME_absolute_get ();
1097   pid = session->target;
1098   /* we'll now call callbacks that may cancel the session; hence
1099    * we should not use 'session' after this point */
1100   while (NULL != (pos = hd))
1101   {
1102     GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
1103     if (pos->transmit_cont != NULL)
1104       pos->transmit_cont (pos->transmit_cont_cls, &pid, GNUNET_OK, pos->message_size, pos->message_size); /* FIXME: include TCP overhead */
1105     GNUNET_free (pos);
1106   }
1107   GNUNET_assert (hd == NULL);
1108   GNUNET_assert (tl == NULL);
1109   LOG (GNUNET_ERROR_TYPE_DEBUG, "Transmitting %u bytes\n",
1110                    ret);
1111   GNUNET_STATISTICS_update (plugin->env->stats,
1112                             gettext_noop ("# bytes currently in TCP buffers"),
1113                             -(int64_t) ret, GNUNET_NO);
1114   GNUNET_STATISTICS_update (plugin->env->stats,
1115                             gettext_noop ("# bytes transmitted via TCP"), ret,
1116                             GNUNET_NO);
1117   return ret;
1118 }
1119
1120
1121 /**
1122  * If we have pending messages, ask the server to
1123  * transmit them (schedule the respective tasks, etc.)
1124  *
1125  * @param session for which session should we do this
1126  */
1127 static void
1128 process_pending_messages (struct Session *session)
1129 {
1130   struct PendingMessage *pm;
1131
1132   GNUNET_assert (session->client != NULL);
1133   if (session->transmit_handle != NULL)
1134     return;
1135   if (NULL == (pm = session->pending_messages_head))
1136     return;
1137
1138   session->transmit_handle =
1139       GNUNET_SERVER_notify_transmit_ready (session->client, pm->message_size,
1140                                            GNUNET_TIME_absolute_get_remaining
1141                                            (pm->timeout), &do_transmit,
1142                                            session);
1143 }
1144
1145
1146 #if EXTRA_CHECKS
1147 /**
1148  * Closure for #session_it().
1149  */
1150 struct FindSessionContext
1151 {
1152   /**
1153    * Session we are looking for.
1154    */
1155   struct Session *s;
1156
1157   /**
1158    * Set to #GNUNET_OK if we found the session.
1159    */
1160   int res;
1161 };
1162
1163
1164 /**
1165  * Function called to check if a session is in our maps.
1166  *
1167  * @param cls the `struct FindSessionContext`
1168  * @param key peer identity
1169  * @param value session in the map
1170  * @return #GNUNET_YES to continue looking, #GNUNET_NO if we found the session
1171  */
1172 static int
1173 session_it (void *cls,
1174             const struct GNUNET_PeerIdentity *key,
1175             void *value)
1176 {
1177   struct FindSessionContext *res = cls;
1178   struct Session *session = value;
1179
1180   if (res->s == session)
1181   {
1182     res->res = GNUNET_OK;
1183     return GNUNET_NO;
1184   }
1185   return GNUNET_YES;
1186 }
1187
1188
1189 /**
1190  * Check that the given session is known to the plugin and
1191  * is in one of our maps.
1192  *
1193  * @param plugin the plugin to check against
1194  * @param session the session to check
1195  * @return #GNUNET_OK if all is well, #GNUNET_SYSERR if the session is invalid
1196  */
1197 static int
1198 find_session (struct Plugin *plugin,
1199               struct Session *session)
1200 {
1201   struct FindSessionContext session_map_res;
1202   struct FindSessionContext nat_map_res;
1203
1204   session_map_res.s = session;
1205   session_map_res.res = GNUNET_SYSERR;
1206   GNUNET_CONTAINER_multipeermap_iterate (plugin->sessionmap,
1207                                          &session_it, &session_map_res);
1208   if (GNUNET_SYSERR != session_map_res.res)
1209     return GNUNET_OK;
1210   nat_map_res.s = session;
1211   nat_map_res.res = GNUNET_SYSERR;
1212   GNUNET_CONTAINER_multipeermap_iterate (plugin->nat_wait_conns,
1213                                          &session_it, &nat_map_res);
1214   if (GNUNET_SYSERR != nat_map_res.res)
1215     return GNUNET_OK;
1216   GNUNET_break (0);
1217   return GNUNET_SYSERR;
1218 }
1219 #endif
1220
1221
1222 /**
1223  * Function that can be used by the transport service to transmit
1224  * a message using the plugin.   Note that in the case of a
1225  * peer disconnecting, the continuation MUST be called
1226  * prior to the disconnect notification itself.  This function
1227  * will be called with this peer's HELLO message to initiate
1228  * a fresh connection to another peer.
1229  *
1230  * @param cls closure
1231  * @param session which session must be used
1232  * @param msgbuf the message to transmit
1233  * @param msgbuf_size number of bytes in 'msgbuf'
1234  * @param priority how important is the message (most plugins will
1235  *                 ignore message priority and just FIFO)
1236  * @param to how long to wait at most for the transmission (does not
1237  *                require plugins to discard the message after the timeout,
1238  *                just advisory for the desired delay; most plugins will ignore
1239  *                this as well)
1240  * @param cont continuation to call once the message has
1241  *        been transmitted (or if the transport is ready
1242  *        for the next transmission call; or if the
1243  *        peer disconnected...); can be NULL
1244  * @param cont_cls closure for @a cont
1245  * @return number of bytes used (on the physical network, with overheads);
1246  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
1247  *         and does NOT mean that the message was not transmitted (DV)
1248  */
1249 static ssize_t
1250 tcp_plugin_send (void *cls,
1251                  struct Session *session,
1252                  const char *msgbuf, size_t msgbuf_size,
1253                  unsigned int priority,
1254                  struct GNUNET_TIME_Relative to,
1255                  GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
1256 {
1257   struct Plugin * plugin = cls;
1258   struct PendingMessage *pm;
1259
1260 #if EXTRA_CHECKS
1261   if (GNUNET_SYSERR == find_session (plugin, session))
1262   {
1263     LOG (GNUNET_ERROR_TYPE_ERROR,
1264          _("Trying to send with invalid session %p\n"));
1265     GNUNET_assert (0);
1266     return GNUNET_SYSERR;
1267   }
1268 #endif
1269   /* create new message entry */
1270   pm = GNUNET_malloc (sizeof (struct PendingMessage) + msgbuf_size);
1271   pm->msg = (const char *) &pm[1];
1272   memcpy (&pm[1], msgbuf, msgbuf_size);
1273   pm->message_size = msgbuf_size;
1274   pm->timeout = GNUNET_TIME_relative_to_absolute (to);
1275   pm->transmit_cont = cont;
1276   pm->transmit_cont_cls = cont_cls;
1277
1278   LOG (GNUNET_ERROR_TYPE_DEBUG,
1279        "Asked to transmit %u bytes to `%s', added message to list.\n",
1280        msgbuf_size, GNUNET_i2s (&session->target));
1281
1282   if (GNUNET_YES ==
1283       GNUNET_CONTAINER_multipeermap_contains_value (plugin->sessionmap,
1284                                                     &session->target,
1285                                                     session))
1286   {
1287     GNUNET_assert (session->client != NULL);
1288     reschedule_session_timeout (session);
1289     GNUNET_SERVER_client_set_timeout (session->client,
1290                                       GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1291     GNUNET_STATISTICS_update (plugin->env->stats,
1292                               gettext_noop ("# bytes currently in TCP buffers"),
1293                               msgbuf_size, GNUNET_NO);
1294
1295     /* append pm to pending_messages list */
1296     GNUNET_CONTAINER_DLL_insert_tail (session->pending_messages_head,
1297                                       session->pending_messages_tail, pm);
1298
1299     process_pending_messages (session);
1300     return msgbuf_size;
1301   }
1302   else if (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains_value(plugin->nat_wait_conns, &session->target, session))
1303   {
1304     LOG (GNUNET_ERROR_TYPE_DEBUG,
1305          "This NAT WAIT session for peer `%s' is not yet ready!\n",
1306          GNUNET_i2s (&session->target));
1307     reschedule_session_timeout (session);
1308     GNUNET_STATISTICS_update (plugin->env->stats,
1309                               gettext_noop ("# bytes currently in TCP buffers"),
1310                               msgbuf_size, GNUNET_NO);
1311
1312     /* append pm to pending_messages list */
1313     GNUNET_CONTAINER_DLL_insert_tail (session->pending_messages_head,
1314                                       session->pending_messages_tail, pm);
1315     return msgbuf_size;
1316   }
1317   else
1318   {
1319     LOG (GNUNET_ERROR_TYPE_ERROR,
1320          "Invalid session %p\n", session);
1321     if (NULL != cont)
1322       cont (cont_cls, &session->target, GNUNET_SYSERR, pm->message_size, 0);
1323     GNUNET_break (0);
1324     GNUNET_free (pm);
1325     return GNUNET_SYSERR; /* session does not exist here */
1326   }
1327 }
1328
1329
1330 /**
1331  * Closure for #session_lookup_it().
1332  */
1333 struct SessionItCtx
1334 {
1335   /**
1336    * Address we are looking for.
1337    */
1338   void *addr;
1339
1340   /**
1341    * Number of bytes in @e addr.
1342    */
1343   size_t addrlen;
1344
1345   /**
1346    * Where to store the session (if we found it).
1347    */
1348   struct Session *result;
1349 };
1350
1351
1352 /**
1353  * Look for a session by address.
1354  *
1355  * @param cls the `struct SessionItCtx`
1356  * @param key unused
1357  * @param value a `struct Session`
1358  * @return #GNUNET_YES to continue looking, #GNUNET_NO if we found the session
1359  */
1360 static int
1361 session_lookup_it (void *cls,
1362                    const struct GNUNET_PeerIdentity *key,
1363                    void *value)
1364 {
1365   struct SessionItCtx * si_ctx = cls;
1366   struct Session * session = value;
1367 #if 0
1368   char * a1 = strdup (tcp_address_to_string(NULL, session->addr, session->addrlen));
1369   char * a2 = strdup (tcp_address_to_string(NULL, si_ctx->addr, si_ctx->addrlen));
1370   LOG (GNUNET_ERROR_TYPE_DEBUG,
1371        "Comparing: %s %u <-> %s %u\n",
1372        a1,
1373        session->addrlen,
1374        a2,
1375        si_ctx->addrlen);
1376   GNUNET_free (a1);
1377   GNUNET_free (a2);
1378 #endif
1379   if (session->addrlen != si_ctx->addrlen)
1380     return GNUNET_YES;
1381   if (0 != memcmp (session->addr, si_ctx->addr, si_ctx->addrlen))
1382     return GNUNET_YES;
1383 #if 0
1384   a1 = strdup (tcp_address_to_string (NULL, session->addr, session->addrlen));
1385   a2 = strdup (tcp_address_to_string (NULL, si_ctx->addr, si_ctx->addrlen));
1386   LOG (GNUNET_ERROR_TYPE_DEBUG,
1387        "Comparing: %s %u <-> %s %u , OK!\n",
1388        a1,
1389        session->addrlen,
1390        a2,
1391        si_ctx->addrlen);
1392   GNUNET_free (a1);
1393   GNUNET_free (a2);
1394 #endif
1395   /* Found existing session */
1396   si_ctx->result = session;
1397   return GNUNET_NO;
1398 }
1399
1400
1401 /**
1402  * Task cleaning up a NAT connection attempt after timeout
1403  *
1404  * @param cls the `struct Session`
1405  * @param tc scheduler context (unused)
1406  */
1407 static void
1408 nat_connect_timeout (void *cls,
1409                      const struct GNUNET_SCHEDULER_TaskContext *tc)
1410 {
1411   struct Session *session = cls;
1412
1413   session->nat_connection_timeout = GNUNET_SCHEDULER_NO_TASK;
1414   LOG (GNUNET_ERROR_TYPE_DEBUG,
1415        "NAT WAIT connection to `%4s' at `%s' could not be established, removing session\n",
1416        GNUNET_i2s (&session->target),
1417        tcp_address_to_string (NULL,
1418                               session->addr, session->addrlen));
1419   tcp_disconnect_session (session->plugin,
1420                           session);
1421 }
1422
1423
1424 /**
1425  * Create a new session to transmit data to the target
1426  * This session will used to send data to this peer and the plugin will
1427  * notify us by calling the env->session_end function
1428  *
1429  * @param cls closure
1430  * @param address the address to use
1431  * @return the session if the address is valid, NULL otherwise
1432  */
1433 static struct Session *
1434 tcp_plugin_get_session (void *cls,
1435                         const struct GNUNET_HELLO_Address *address)
1436 {
1437   struct Plugin *plugin = cls;
1438   struct Session *session = NULL;
1439   int af;
1440   const void *sb;
1441   size_t sbs;
1442   struct GNUNET_CONNECTION_Handle *sa;
1443   struct sockaddr_in a4;
1444   struct sockaddr_in6 a6;
1445   const struct IPv4TcpAddress *t4;
1446   const struct IPv6TcpAddress *t6;
1447   struct GNUNET_ATS_Information ats;
1448   unsigned int is_natd = GNUNET_NO;
1449   size_t addrlen;
1450
1451   addrlen = address->address_length;
1452   LOG (GNUNET_ERROR_TYPE_DEBUG,
1453        "Trying to get session for `%s' address of peer `%s'\n",
1454        tcp_address_to_string(NULL, address->address, address->address_length),
1455        GNUNET_i2s (&address->peer));
1456
1457   /* look for existing session */
1458   if (GNUNET_YES ==
1459       GNUNET_CONTAINER_multipeermap_contains (plugin->sessionmap,
1460                                               &address->peer))
1461   {
1462     struct SessionItCtx si_ctx;
1463
1464     si_ctx.addr = (void *) address->address;
1465     si_ctx.addrlen = address->address_length;
1466
1467     si_ctx.result = NULL;
1468
1469     GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessionmap,
1470                                                 &address->peer,
1471                                                 &session_lookup_it, &si_ctx);
1472     if (si_ctx.result != NULL)
1473     {
1474       session = si_ctx.result;
1475       LOG (GNUNET_ERROR_TYPE_DEBUG,
1476            "Found existing session for `%s' address `%s' session %p\n",
1477            GNUNET_i2s (&address->peer),
1478            tcp_address_to_string(NULL, address->address, address->address_length),
1479            session);
1480       return session;
1481     }
1482     LOG (GNUNET_ERROR_TYPE_DEBUG,
1483          "Existing sessions did not match address `%s' or peer `%s'\n",
1484          tcp_address_to_string(NULL, address->address, address->address_length),
1485          GNUNET_i2s (&address->peer));
1486   }
1487
1488   if (addrlen == sizeof (struct IPv6TcpAddress))
1489   {
1490     GNUNET_assert (NULL != address->address);     /* make static analysis happy */
1491     t6 = address->address;
1492     af = AF_INET6;
1493     memset (&a6, 0, sizeof (a6));
1494 #if HAVE_SOCKADDR_IN_SIN_LEN
1495     a6.sin6_len = sizeof (a6);
1496 #endif
1497     a6.sin6_family = AF_INET6;
1498     a6.sin6_port = t6->t6_port;
1499     if (t6->t6_port == 0)
1500       is_natd = GNUNET_YES;
1501     memcpy (&a6.sin6_addr, &t6->ipv6_addr, sizeof (struct in6_addr));
1502     sb = &a6;
1503     sbs = sizeof (a6);
1504   }
1505   else if (addrlen == sizeof (struct IPv4TcpAddress))
1506   {
1507     GNUNET_assert (NULL != address->address);     /* make static analysis happy */
1508     t4 = address->address;
1509     af = AF_INET;
1510     memset (&a4, 0, sizeof (a4));
1511 #if HAVE_SOCKADDR_IN_SIN_LEN
1512     a4.sin_len = sizeof (a4);
1513 #endif
1514     a4.sin_family = AF_INET;
1515     a4.sin_port = t4->t4_port;
1516     if (t4->t4_port == 0)
1517       is_natd = GNUNET_YES;
1518     a4.sin_addr.s_addr = t4->ipv4_addr;
1519     sb = &a4;
1520     sbs = sizeof (a4);
1521   }
1522   else
1523   {
1524     GNUNET_STATISTICS_update (plugin->env->stats,
1525                               gettext_noop
1526                               ("# requests to create session with invalid address"),
1527                               1, GNUNET_NO);
1528     return NULL;
1529   }
1530
1531   ats = plugin->env->get_address_type (plugin->env->cls, sb, sbs);
1532
1533   if ((is_natd == GNUNET_YES) && (addrlen == sizeof (struct IPv6TcpAddress)))
1534   {
1535     /* NAT client only works with IPv4 addresses */
1536     return NULL;
1537   }
1538
1539   if (plugin->cur_connections >= plugin->max_connections)
1540   {
1541     /* saturated */
1542     return NULL;
1543   }
1544
1545   if ((is_natd == GNUNET_YES) &&
1546       (GNUNET_YES ==
1547        GNUNET_CONTAINER_multipeermap_contains (plugin->nat_wait_conns,
1548                                                &address->peer)))
1549   {
1550     /* Only do one NAT punch attempt per peer identity */
1551      return NULL;
1552   }
1553
1554   if ((is_natd == GNUNET_YES) && (NULL != plugin->nat) &&
1555       (GNUNET_NO ==
1556        GNUNET_CONTAINER_multipeermap_contains (plugin->nat_wait_conns,
1557                                                &address->peer)))
1558   {
1559     LOG (GNUNET_ERROR_TYPE_DEBUG,
1560          "Found valid IPv4 NAT address (creating session)!\n") ;
1561     session = create_session (plugin,
1562                               &address->peer,
1563                               NULL,
1564                               GNUNET_YES);
1565     session->addrlen = 0;
1566     session->addr = NULL;
1567     session->ats_address_network_type = (enum GNUNET_ATS_Network_Type) ntohl (ats.value)
1568 ;
1569     GNUNET_break (session->ats_address_network_type != GNUNET_ATS_NET_UNSPECIFIED);
1570     session->nat_connection_timeout = GNUNET_SCHEDULER_add_delayed (NAT_TIMEOUT,
1571                                                                     &nat_connect_timeout,
1572                                                                     session);
1573     GNUNET_assert (session != NULL);
1574     GNUNET_assert (GNUNET_OK ==
1575                    GNUNET_CONTAINER_multipeermap_put (plugin->nat_wait_conns,
1576                                                       &session->target,
1577                                                       session,
1578                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1579
1580     LOG (GNUNET_ERROR_TYPE_DEBUG,
1581          "Created NAT WAIT connection to `%4s' at `%s'\n",
1582          GNUNET_i2s (&session->target), GNUNET_a2s (sb, sbs));
1583
1584     if (GNUNET_OK == GNUNET_NAT_run_client (plugin->nat, &a4))
1585       return session;
1586     else
1587     {
1588       LOG (GNUNET_ERROR_TYPE_DEBUG,
1589            "Running NAT client for `%4s' at `%s' failed\n",
1590            GNUNET_i2s (&session->target), GNUNET_a2s (sb, sbs));
1591       tcp_disconnect_session (plugin, session);
1592       return NULL;
1593     }
1594   }
1595
1596   /* create new outbound session */
1597   GNUNET_assert (plugin->cur_connections <= plugin->max_connections);
1598   sa = GNUNET_CONNECTION_create_from_sockaddr (af, sb, sbs);
1599   if (sa == NULL)
1600   {
1601     LOG (GNUNET_ERROR_TYPE_DEBUG,
1602          "Failed to create connection to `%4s' at `%s'\n",
1603          GNUNET_i2s (&address->peer), GNUNET_a2s (sb, sbs));
1604     return NULL;
1605   }
1606   plugin->cur_connections++;
1607   if (plugin->cur_connections == plugin->max_connections)
1608     GNUNET_SERVER_suspend (plugin->server); /* Maximum number of connections rechead */
1609
1610   LOG (GNUNET_ERROR_TYPE_DEBUG,
1611        "Asked to transmit to `%4s', creating fresh session using address `%s'.\n",
1612        GNUNET_i2s (&address->peer),
1613        GNUNET_a2s (sb, sbs));
1614
1615   session = create_session (plugin,
1616                             &address->peer,
1617                             GNUNET_SERVER_connect_socket (plugin->server, sa),
1618                             GNUNET_NO);
1619   session->addr = GNUNET_malloc (addrlen);
1620   memcpy (session->addr, address->address, addrlen);
1621   session->addrlen = addrlen;
1622   session->ats_address_network_type = (enum GNUNET_ATS_Network_Type) ntohl (ats.value);
1623   GNUNET_break (session->ats_address_network_type != GNUNET_ATS_NET_UNSPECIFIED);
1624   GNUNET_SERVER_client_set_user_context (session->client, session);
1625   GNUNET_CONTAINER_multipeermap_put (plugin->sessionmap,
1626                                      &session->target,
1627                                      session,
1628                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1629   LOG (GNUNET_ERROR_TYPE_DEBUG,
1630        "Creating new session for `%s' address `%s' session %p\n",
1631        GNUNET_i2s (&address->peer),
1632        tcp_address_to_string(NULL, address->address, address->address_length),
1633        session);
1634   /* Send TCP Welcome */
1635   process_pending_messages (session);
1636
1637   return session;
1638 }
1639
1640
1641 static int
1642 session_disconnect_it (void *cls,
1643                        const struct GNUNET_PeerIdentity *key,
1644                        void *value)
1645 {
1646   struct Plugin *plugin = cls;
1647   struct Session *session = value;
1648
1649   GNUNET_STATISTICS_update (session->plugin->env->stats,
1650                             gettext_noop
1651                             ("# transport-service disconnect requests for TCP"),
1652                             1, GNUNET_NO);
1653   tcp_disconnect_session (plugin,
1654                           session);
1655   return GNUNET_YES;
1656 }
1657
1658
1659 /**
1660  * Function that can be called to force a disconnect from the
1661  * specified neighbour.  This should also cancel all previously
1662  * scheduled transmissions.  Obviously the transmission may have been
1663  * partially completed already, which is OK.  The plugin is supposed
1664  * to close the connection (if applicable) and no longer call the
1665  * transmit continuation(s).
1666  *
1667  * Finally, plugin MUST NOT call the services's receive function to
1668  * notify the service that the connection to the specified target was
1669  * closed after a getting this call.
1670  *
1671  * @param cls closure
1672  * @param target peer for which the last transmission is
1673  *        to be cancelled
1674  */
1675 static void
1676 tcp_plugin_disconnect (void *cls,
1677                        const struct GNUNET_PeerIdentity *target)
1678 {
1679   struct Plugin *plugin = cls;
1680
1681   LOG (GNUNET_ERROR_TYPE_DEBUG,
1682        "Disconnecting peer `%4s'\n",
1683        GNUNET_i2s (target));
1684   GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessionmap, target,
1685                                               &session_disconnect_it, plugin);
1686   GNUNET_CONTAINER_multipeermap_get_multiple (plugin->nat_wait_conns, target,
1687                                               &session_disconnect_it, plugin);
1688 }
1689
1690
1691 /**
1692  * Running pretty printers: head
1693  */
1694 static struct PrettyPrinterContext *ppc_dll_head;
1695
1696 /**
1697  * Running pretty printers: tail
1698  */
1699 static struct PrettyPrinterContext *ppc_dll_tail;
1700
1701 /**
1702  * Context for address to string conversion.
1703  */
1704 struct PrettyPrinterContext
1705 {
1706   /**
1707    * DLL
1708    */
1709   struct PrettyPrinterContext *next;
1710
1711   /**
1712    * DLL
1713    */
1714   struct PrettyPrinterContext *prev;
1715
1716   /**
1717    * Timeout task
1718    */
1719   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
1720
1721   /**
1722    * Resolver handle
1723    */
1724   struct GNUNET_RESOLVER_RequestHandle *resolver_handle;
1725
1726   /**
1727    * Function to call with the result.
1728    */
1729   GNUNET_TRANSPORT_AddressStringCallback asc;
1730
1731   /**
1732    * Clsoure for 'asc'.
1733    */
1734   void *asc_cls;
1735
1736   /**
1737    * Port to add after the IP address.
1738    */
1739   uint16_t port;
1740
1741   /**
1742    * IPv6 address
1743    */
1744   int ipv6;
1745
1746   /**
1747    * Options
1748    */
1749   uint32_t options;
1750 };
1751
1752
1753 static void
1754 ppc_cancel_task (void *cls,
1755                  const struct GNUNET_SCHEDULER_TaskContext *tc)
1756 {
1757   int count = 0;
1758   struct PrettyPrinterContext *ppc = cls;
1759   struct PrettyPrinterContext *cur;
1760
1761   for (cur = ppc_dll_head; (NULL != cur); cur = cur->next)
1762   {
1763     if (cur != ppc)
1764       count++;
1765   }
1766
1767   // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Cancel request %p, %u pending\n", ppc, count);
1768   ppc->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1769   if (NULL != ppc->resolver_handle)
1770   {
1771     GNUNET_RESOLVER_request_cancel (ppc->resolver_handle);
1772     ppc->resolver_handle = NULL;
1773   }
1774   GNUNET_CONTAINER_DLL_remove (ppc_dll_head, ppc_dll_tail, ppc);
1775   GNUNET_free (ppc);
1776 }
1777
1778
1779 /**
1780  * Append our port and forward the result.
1781  *
1782  * @param cls the 'struct PrettyPrinterContext*'
1783  * @param hostname hostname part of the address
1784  */
1785 static void
1786 append_port (void *cls, const char *hostname)
1787 {
1788   struct PrettyPrinterContext *ppc = cls;
1789   struct PrettyPrinterContext *cur;
1790   char *ret;
1791   int count = 0;
1792
1793   for (cur = ppc_dll_head; (NULL != cur); cur = cur->next)
1794   {
1795     if (cur != ppc)
1796       count++;
1797   }
1798   //GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Callback request %p == %s, %u pending\n", ppc, hostname, count);
1799   if (hostname == NULL)
1800   {
1801     ppc->asc (ppc->asc_cls, NULL);
1802     GNUNET_CONTAINER_DLL_remove (ppc_dll_head, ppc_dll_tail, ppc);
1803     GNUNET_SCHEDULER_cancel (ppc->timeout_task);
1804     ppc->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1805     ppc->resolver_handle = NULL;
1806     //GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Done request %p, %u pending\n", ppc, count);
1807     GNUNET_free (ppc);
1808     return;
1809   }
1810   for (cur = ppc_dll_head; (NULL != cur); cur = cur->next)
1811   {
1812         if (cur == ppc)
1813                 break;
1814   }
1815   if (NULL == cur)
1816   {
1817         GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Invalid callback for PPC %p \n", ppc);
1818         return;
1819   }
1820
1821   if (GNUNET_YES == ppc->ipv6)
1822     GNUNET_asprintf (&ret, "%s.%u.[%s]:%d", PLUGIN_NAME, ppc->options, hostname, ppc->port);
1823   else
1824     GNUNET_asprintf (&ret, "%s.%u.%s:%d", PLUGIN_NAME, ppc->options, hostname, ppc->port);
1825   ppc->asc (ppc->asc_cls, ret);
1826   GNUNET_free (ret);
1827 }
1828
1829
1830 /**
1831  * Convert the transports address to a nice, human-readable
1832  * format.
1833  *
1834  * @param cls closure
1835  * @param type name of the transport that generated the address
1836  * @param addr one of the addresses of the host, NULL for the last address
1837  *        the specific address format depends on the transport
1838  * @param addrlen length of the address
1839  * @param numeric should (IP) addresses be displayed in numeric form?
1840  * @param timeout after how long should we give up?
1841  * @param asc function to call on each string
1842  * @param asc_cls closure for asc
1843  */
1844 static void
1845 tcp_plugin_address_pretty_printer (void *cls, const char *type,
1846                                    const void *addr, size_t addrlen,
1847                                    int numeric,
1848                                    struct GNUNET_TIME_Relative timeout,
1849                                    GNUNET_TRANSPORT_AddressStringCallback asc,
1850                                    void *asc_cls)
1851 {
1852   struct PrettyPrinterContext *ppc;
1853   const void *sb;
1854   size_t sbs;
1855   struct sockaddr_in a4;
1856   struct sockaddr_in6 a6;
1857   const struct IPv4TcpAddress *t4;
1858   const struct IPv6TcpAddress *t6;
1859   uint16_t port;
1860   uint32_t options;
1861
1862   if (addrlen == sizeof (struct IPv6TcpAddress))
1863   {
1864     t6 = addr;
1865     memset (&a6, 0, sizeof (a6));
1866     a6.sin6_family = AF_INET6;
1867     a6.sin6_port = t6->t6_port;
1868     memcpy (&a6.sin6_addr, &t6->ipv6_addr, sizeof (struct in6_addr));
1869     port = ntohs (t6->t6_port);
1870     options = ntohl (t6->options);
1871     sb = &a6;
1872     sbs = sizeof (a6);
1873   }
1874   else if (addrlen == sizeof (struct IPv4TcpAddress))
1875   {
1876     t4 = addr;
1877     memset (&a4, 0, sizeof (a4));
1878     a4.sin_family = AF_INET;
1879     a4.sin_port = t4->t4_port;
1880     a4.sin_addr.s_addr = t4->ipv4_addr;
1881     port = ntohs (t4->t4_port);
1882     options = ntohl (t4->options);
1883     sb = &a4;
1884     sbs = sizeof (a4);
1885   }
1886   else if (0 == addrlen)
1887   {
1888     asc (asc_cls, TRANSPORT_SESSION_INBOUND_STRING);
1889     asc (asc_cls, NULL);
1890     return;
1891   }
1892   else
1893   {
1894     /* invalid address */
1895     GNUNET_break_op (0);
1896     asc (asc_cls, NULL);
1897     return;
1898   }
1899   ppc = GNUNET_malloc (sizeof (struct PrettyPrinterContext));
1900   if (addrlen == sizeof (struct IPv6TcpAddress))
1901     ppc->ipv6 = GNUNET_YES;
1902   else
1903     ppc->ipv6 = GNUNET_NO;
1904   ppc->asc = asc;
1905   ppc->asc_cls = asc_cls;
1906   ppc->port = port;
1907   ppc->options = options;
1908   ppc->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply(timeout, 2),
1909                                                     &ppc_cancel_task, ppc);
1910   ppc->resolver_handle = GNUNET_RESOLVER_hostname_get (sb, sbs, !numeric,
1911                                                        timeout,
1912                                                        &append_port, ppc);
1913   if (NULL != ppc->resolver_handle)
1914   {
1915     //GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Adding request %p\n", ppc);
1916     GNUNET_CONTAINER_DLL_insert (ppc_dll_head, ppc_dll_tail, ppc);
1917   }
1918   else
1919   {
1920     GNUNET_break (0);
1921     GNUNET_free (ppc);
1922   }
1923 }
1924
1925
1926 /**
1927  * Check if the given port is plausible (must be either our listen
1928  * port or our advertised port), or any port if we are behind NAT
1929  * and do not have a port open.  If it is neither, we return
1930  * #GNUNET_SYSERR.
1931  *
1932  * @param plugin global variables
1933  * @param in_port port number to check
1934  * @return #GNUNET_OK if port is either open_port or adv_port
1935  */
1936 static int
1937 check_port (struct Plugin *plugin, uint16_t in_port)
1938 {
1939   if ((in_port == plugin->adv_port) || (in_port == plugin->open_port))
1940     return GNUNET_OK;
1941   return GNUNET_SYSERR;
1942 }
1943
1944
1945 /**
1946  * Function that will be called to check if a binary address for this
1947  * plugin is well-formed and corresponds to an address for THIS peer
1948  * (as per our configuration).  Naturally, if absolutely necessary,
1949  * plugins can be a bit conservative in their answer, but in general
1950  * plugins should make sure that the address does not redirect
1951  * traffic to a 3rd party that might try to man-in-the-middle our
1952  * traffic.
1953  *
1954  * @param cls closure, our 'struct Plugin*'
1955  * @param addr pointer to the address
1956  * @param addrlen length of addr
1957  * @return #GNUNET_OK if this is a plausible address for this peer
1958  *         and transport, #GNUNET_SYSERR if not
1959  */
1960 static int
1961 tcp_plugin_check_address (void *cls, const void *addr, size_t addrlen)
1962 {
1963   struct Plugin *plugin = cls;
1964   struct IPv4TcpAddress *v4;
1965   struct IPv6TcpAddress *v6;
1966
1967   if ((addrlen != sizeof (struct IPv4TcpAddress)) &&
1968       (addrlen != sizeof (struct IPv6TcpAddress)))
1969   {
1970
1971
1972         return GNUNET_SYSERR;
1973   }
1974
1975   if (addrlen == sizeof (struct IPv4TcpAddress))
1976   {
1977     v4 = (struct IPv4TcpAddress *) addr;
1978     if (0 != memcmp (&v4->options, &myoptions, sizeof (myoptions)))
1979     {
1980         GNUNET_break (0);
1981         return GNUNET_SYSERR;
1982     }
1983     if (GNUNET_OK != check_port (plugin, ntohs (v4->t4_port)))
1984       return GNUNET_SYSERR;
1985     if (GNUNET_OK !=
1986         GNUNET_NAT_test_address (plugin->nat, &v4->ipv4_addr,
1987                                  sizeof (struct in_addr)))
1988       return GNUNET_SYSERR;
1989   }
1990   else
1991   {
1992     v6 = (struct IPv6TcpAddress *) addr;
1993     if (IN6_IS_ADDR_LINKLOCAL (&v6->ipv6_addr))
1994     {
1995       GNUNET_break_op (0);
1996       return GNUNET_SYSERR;
1997     }
1998     if (0 != memcmp (&v6->options, &myoptions, sizeof (myoptions)))
1999     {
2000         GNUNET_break (0);
2001         return GNUNET_SYSERR;
2002     }
2003     if (GNUNET_OK != check_port (plugin, ntohs (v6->t6_port)))
2004       return GNUNET_SYSERR;
2005     if (GNUNET_OK !=
2006         GNUNET_NAT_test_address (plugin->nat, &v6->ipv6_addr,
2007                                  sizeof (struct in6_addr)))
2008       return GNUNET_SYSERR;
2009   }
2010   return GNUNET_OK;
2011 }
2012
2013
2014 /**
2015  * We've received a nat probe from this peer via TCP.  Finish
2016  * creating the client session and resume sending of queued
2017  * messages.
2018  *
2019  * @param cls closure
2020  * @param client identification of the client
2021  * @param message the actual message
2022  */
2023 static void
2024 handle_tcp_nat_probe (void *cls,
2025                       struct GNUNET_SERVER_Client *client,
2026                       const struct GNUNET_MessageHeader *message)
2027 {
2028   struct Plugin *plugin = cls;
2029   struct Session *session;
2030   const struct TCP_NAT_ProbeMessage *tcp_nat_probe;
2031   size_t alen;
2032   void *vaddr;
2033   struct IPv4TcpAddress *t4;
2034   struct IPv6TcpAddress *t6;
2035   const struct sockaddr_in *s4;
2036   const struct sockaddr_in6 *s6;
2037
2038   LOG (GNUNET_ERROR_TYPE_DEBUG,
2039        "Received NAT probe\n");
2040   /* We have received a TCP NAT probe, meaning we (hopefully) initiated
2041    * a connection to this peer by running gnunet-nat-client.  This peer
2042    * received the punch message and now wants us to use the new connection
2043    * as the default for that peer.  Do so and then send a WELCOME message
2044    * so we can really be connected!
2045    */
2046   if (ntohs (message->size) != sizeof (struct TCP_NAT_ProbeMessage))
2047   {
2048     GNUNET_break_op (0);
2049     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2050     return;
2051   }
2052
2053   tcp_nat_probe = (const struct TCP_NAT_ProbeMessage *) message;
2054   if (0 ==
2055       memcmp (&tcp_nat_probe->clientIdentity, plugin->env->my_identity,
2056               sizeof (struct GNUNET_PeerIdentity)))
2057   {
2058     /* refuse connections from ourselves */
2059     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2060     return;
2061   }
2062
2063   session =
2064     GNUNET_CONTAINER_multipeermap_get (plugin->nat_wait_conns,
2065                                        &tcp_nat_probe->clientIdentity);
2066   if (session == NULL)
2067   {
2068     LOG (GNUNET_ERROR_TYPE_DEBUG,
2069          "Did NOT find session for NAT probe!\n");
2070     GNUNET_SERVER_receive_done (client, GNUNET_OK);
2071     return;
2072   }
2073   LOG (GNUNET_ERROR_TYPE_DEBUG,
2074        "Found session for NAT probe!\n");
2075
2076   if (session->nat_connection_timeout != GNUNET_SCHEDULER_NO_TASK)
2077   {
2078     GNUNET_SCHEDULER_cancel (session->nat_connection_timeout);
2079     session->nat_connection_timeout = GNUNET_SCHEDULER_NO_TASK;
2080   }
2081
2082   if (GNUNET_OK != GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2083   {
2084     GNUNET_break (0);
2085     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2086     tcp_disconnect_session (plugin, session);
2087     return;
2088   }
2089   GNUNET_assert (GNUNET_CONTAINER_multipeermap_remove
2090                  (plugin->nat_wait_conns,
2091                   &tcp_nat_probe->clientIdentity,
2092                   session) == GNUNET_YES);
2093   GNUNET_SERVER_client_set_user_context (client, session);
2094   GNUNET_CONTAINER_multipeermap_put (plugin->sessionmap,
2095                                      &session->target, session,
2096                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2097   session->last_activity = GNUNET_TIME_absolute_get ();
2098   session->inbound = GNUNET_NO;
2099   LOG (GNUNET_ERROR_TYPE_DEBUG,
2100        "Found address `%s' for incoming connection\n",
2101        GNUNET_a2s (vaddr, alen));
2102   switch (((const struct sockaddr *) vaddr)->sa_family)
2103   {
2104   case AF_INET:
2105     s4 = vaddr;
2106     t4 = GNUNET_new (struct IPv4TcpAddress);
2107     t4->options = 0;
2108     t4->t4_port = s4->sin_port;
2109     t4->ipv4_addr = s4->sin_addr.s_addr;
2110     session->addr = t4;
2111     session->addrlen = sizeof (struct IPv4TcpAddress);
2112     break;
2113   case AF_INET6:
2114     s6 = vaddr;
2115     t6 = GNUNET_new (struct IPv6TcpAddress);
2116     t6->options = 0;
2117     t6->t6_port = s6->sin6_port;
2118     memcpy (&t6->ipv6_addr, &s6->sin6_addr, sizeof (struct in6_addr));
2119     session->addr = t6;
2120     session->addrlen = sizeof (struct IPv6TcpAddress);
2121     break;
2122   default:
2123     GNUNET_break_op (0);
2124     LOG (GNUNET_ERROR_TYPE_DEBUG,
2125          "Bad address for incoming connection!\n");
2126     GNUNET_free (vaddr);
2127     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2128     tcp_disconnect_session (plugin, session);
2129     return;
2130   }
2131   GNUNET_free (vaddr);
2132   GNUNET_break (NULL == session->client);
2133   GNUNET_SERVER_client_keep (client);
2134   session->client = client;
2135   GNUNET_STATISTICS_update (plugin->env->stats,
2136                             gettext_noop ("# TCP sessions active"), 1,
2137                             GNUNET_NO);
2138   process_pending_messages (session);
2139   GNUNET_SERVER_receive_done (client, GNUNET_OK);
2140 }
2141
2142
2143 /**
2144  * We've received a welcome from this peer via TCP.  Possibly create a
2145  * fresh client record and send back our welcome.
2146  *
2147  * @param cls closure
2148  * @param client identification of the client
2149  * @param message the actual message
2150  */
2151 static void
2152 handle_tcp_welcome (void *cls, struct GNUNET_SERVER_Client *client,
2153                     const struct GNUNET_MessageHeader *message)
2154 {
2155   struct Plugin *plugin = cls;
2156   const struct WelcomeMessage *wm = (const struct WelcomeMessage *) message;
2157   struct Session *session;
2158   size_t alen;
2159   void *vaddr;
2160   struct IPv4TcpAddress *t4;
2161   struct IPv6TcpAddress *t6;
2162   const struct sockaddr_in *s4;
2163   const struct sockaddr_in6 *s6;
2164   struct GNUNET_ATS_Information ats;
2165
2166   if (0 ==
2167       memcmp (&wm->clientIdentity, plugin->env->my_identity,
2168               sizeof (struct GNUNET_PeerIdentity)))
2169   {
2170     /* refuse connections from ourselves */
2171     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2172     if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2173     {
2174         LOG (GNUNET_ERROR_TYPE_WARNING,
2175          "Received %s message from my own identity `%4s' on address `%s'\n",
2176          "WELCOME", GNUNET_i2s (&wm->clientIdentity), GNUNET_a2s (vaddr, alen));
2177         GNUNET_free (vaddr);
2178     }
2179     GNUNET_break_op (0);
2180     return;
2181   }
2182   LOG (GNUNET_ERROR_TYPE_DEBUG,
2183        "Received %s message from `%4s' %p\n", "WELCOME",
2184        GNUNET_i2s (&wm->clientIdentity), client);
2185   GNUNET_STATISTICS_update (plugin->env->stats,
2186                             gettext_noop ("# TCP WELCOME messages received"), 1,
2187                             GNUNET_NO);
2188   session = lookup_session_by_client (plugin, client);
2189   if (session != NULL)
2190   {
2191     if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2192     {
2193       LOG (GNUNET_ERROR_TYPE_DEBUG,
2194            "Found existing session %p for peer `%s'\n",
2195            session,
2196            GNUNET_a2s (vaddr, alen));
2197       GNUNET_free (vaddr);
2198     }
2199   }
2200   else
2201   {
2202     GNUNET_SERVER_client_keep (client);
2203     if (plugin->service != NULL) /* Otherwise value is incremented in tcp_access_check */
2204         plugin->cur_connections++;
2205     if (plugin->cur_connections == plugin->max_connections)
2206         GNUNET_SERVER_suspend (plugin->server); /* Maximum number of connections rechead */
2207
2208     session = create_session (plugin, &wm->clientIdentity, client, GNUNET_NO);
2209     session->inbound = GNUNET_YES;
2210     if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2211     {
2212       if (alen == sizeof (struct sockaddr_in))
2213       {
2214         s4 = vaddr;
2215         t4 = GNUNET_new (struct IPv4TcpAddress);
2216         t4->options = htonl (0);
2217         t4->t4_port = s4->sin_port;
2218         t4->ipv4_addr = s4->sin_addr.s_addr;
2219         session->addr = t4;
2220         session->addrlen = sizeof (struct IPv4TcpAddress);
2221       }
2222       else if (alen == sizeof (struct sockaddr_in6))
2223       {
2224         s6 = vaddr;
2225         t6 = GNUNET_new (struct IPv6TcpAddress);
2226         t6->options = htonl (0);
2227         t6->t6_port = s6->sin6_port;
2228         memcpy (&t6->ipv6_addr, &s6->sin6_addr, sizeof (struct in6_addr));
2229         session->addr = t6;
2230         session->addrlen = sizeof (struct IPv6TcpAddress);
2231       }
2232
2233       ats = plugin->env->get_address_type (plugin->env->cls, vaddr ,alen);
2234       session->ats_address_network_type = (enum GNUNET_ATS_Network_Type) ntohl (ats.value);
2235       LOG (GNUNET_ERROR_TYPE_DEBUG,
2236            "Creating new session %p for peer `%s'\n",
2237            session,
2238            GNUNET_a2s (vaddr, alen));
2239       GNUNET_free (vaddr);
2240       GNUNET_SERVER_client_set_user_context (session->client, session);
2241       GNUNET_CONTAINER_multipeermap_put (plugin->sessionmap,
2242                                          &session->target,
2243                                          session,
2244                                          GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2245     }
2246     else
2247     {
2248       LOG (GNUNET_ERROR_TYPE_DEBUG,
2249            "Did not obtain TCP socket address for incoming connection\n");
2250       GNUNET_break (0);
2251     }
2252   }
2253
2254   if (session->expecting_welcome != GNUNET_YES)
2255   {
2256     GNUNET_break_op (0);
2257     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2258     GNUNET_break (0);
2259     return;
2260   }
2261   session->last_activity = GNUNET_TIME_absolute_get ();
2262   session->expecting_welcome = GNUNET_NO;
2263
2264   /* Notify transport and ATS about new session */
2265   if (GNUNET_YES == session->inbound)
2266   {
2267         plugin->env->session_start (NULL, &wm->clientIdentity, PLUGIN_NAME,
2268                 (GNUNET_YES == session->inbound) ? NULL : session->addr,
2269                   (GNUNET_YES == session->inbound) ? 0 : session->addrlen,
2270                   session, &ats, 1);
2271   }
2272
2273   process_pending_messages (session);
2274
2275   GNUNET_SERVER_client_set_timeout (client,
2276                                     GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2277   GNUNET_SERVER_receive_done (client, GNUNET_OK);
2278 }
2279
2280
2281 /**
2282  * Task to signal the server that we can continue
2283  * receiving from the TCP client now.
2284  *
2285  * @param cls the 'struct Session*'
2286  * @param tc task context (unused)
2287  */
2288 static void
2289 delayed_done (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
2290 {
2291   struct Session *session = cls;
2292
2293   session->receive_delay_task = GNUNET_SCHEDULER_NO_TASK;
2294   reschedule_session_timeout (session);
2295
2296   GNUNET_SERVER_receive_done (session->client, GNUNET_OK);
2297 }
2298
2299
2300 /**
2301  * We've received data for this peer via TCP.  Unbox,
2302  * compute latency and forward.
2303  *
2304  * @param cls closure
2305  * @param client identification of the client
2306  * @param message the actual message
2307  */
2308 static void
2309 handle_tcp_data (void *cls, struct GNUNET_SERVER_Client *client,
2310                  const struct GNUNET_MessageHeader *message)
2311 {
2312   struct Plugin *plugin = cls;
2313   struct Session *session;
2314   struct GNUNET_TIME_Relative delay;
2315   uint16_t type;
2316
2317   type = ntohs (message->type);
2318   if ((GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME == type) ||
2319       (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE == type))
2320   {
2321     /* We don't want to propagate WELCOME and NAT Probe messages up! */
2322     GNUNET_SERVER_receive_done (client, GNUNET_OK);
2323     return;
2324   }
2325   session = lookup_session_by_client (plugin, client);
2326   if (NULL == session)
2327   {
2328     /* No inbound session found */
2329     void *vaddr;
2330     size_t alen;
2331
2332     GNUNET_SERVER_client_get_address (client, &vaddr, &alen);
2333     LOG (GNUNET_ERROR_TYPE_ERROR,
2334          "Received unexpected %u bytes of type %u from `%s'\n",
2335          (unsigned int) ntohs (message->size),
2336          (unsigned int) ntohs (message->type),
2337          GNUNET_a2s(vaddr, alen));
2338     GNUNET_break_op (0);
2339     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2340     GNUNET_free_non_null(vaddr);
2341     return;
2342   }
2343   else if (GNUNET_YES == session->expecting_welcome)
2344   {
2345     /* Session is expecting WELCOME message */
2346     void *vaddr;
2347     size_t alen;
2348
2349     GNUNET_SERVER_client_get_address (client, &vaddr, &alen);
2350     LOG (GNUNET_ERROR_TYPE_ERROR,
2351          "Received unexpected %u bytes of type %u from `%s'\n",
2352          (unsigned int) ntohs (message->size),
2353          (unsigned int) ntohs (message->type),
2354          GNUNET_a2s(vaddr, alen));
2355     GNUNET_break_op (0);
2356     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2357     GNUNET_free_non_null(vaddr);
2358     return;
2359   }
2360
2361   session->last_activity = GNUNET_TIME_absolute_get ();
2362   LOG (GNUNET_ERROR_TYPE_DEBUG,
2363                    "Passing %u bytes of type %u from `%4s' to transport service.\n",
2364                    (unsigned int) ntohs (message->size),
2365                    (unsigned int) ntohs (message->type),
2366                    GNUNET_i2s (&session->target));
2367
2368   GNUNET_STATISTICS_update (plugin->env->stats,
2369                             gettext_noop ("# bytes received via TCP"),
2370                             ntohs (message->size), GNUNET_NO);
2371   struct GNUNET_ATS_Information distance;
2372
2373   distance.type = htonl (GNUNET_ATS_NETWORK_TYPE);
2374   distance.value = htonl ((uint32_t) session->ats_address_network_type);
2375   GNUNET_break (session->ats_address_network_type != GNUNET_ATS_NET_UNSPECIFIED);
2376
2377   GNUNET_assert (GNUNET_CONTAINER_multipeermap_contains_value (plugin->sessionmap,
2378                                                                &session->target,
2379                                                                session));
2380
2381   delay = plugin->env->receive (plugin->env->cls,
2382                                 &session->target,
2383                                 message,
2384                                 session,
2385                                 (GNUNET_YES == session->inbound) ? NULL : session->addr,
2386                                 (GNUNET_YES == session->inbound) ? 0 : session->addrlen);
2387   plugin->env->update_address_metrics (plugin->env->cls,
2388                                        &session->target,
2389                                        (GNUNET_YES == session->inbound) ? NULL : session->addr,
2390                                        (GNUNET_YES == session->inbound) ? 0 : session->addrlen,
2391                                        session, &distance, 1);
2392   reschedule_session_timeout (session);
2393   if (0 == delay.rel_value_us)
2394   {
2395     GNUNET_SERVER_receive_done (client, GNUNET_OK);
2396   }
2397   else
2398   {
2399     LOG (GNUNET_ERROR_TYPE_DEBUG,
2400          "Throttling receiving from `%s' for %s\n",
2401          GNUNET_i2s (&session->target),
2402          GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
2403     GNUNET_SERVER_disable_receive_done_warning (client);
2404     session->receive_delay_task =
2405       GNUNET_SCHEDULER_add_delayed (delay, &delayed_done, session);
2406   }
2407 }
2408
2409
2410 /**
2411  * Functions with this signature are called whenever a peer
2412  * is disconnected on the network level.
2413  *
2414  * @param cls closure
2415  * @param client identification of the client
2416  */
2417 static void
2418 disconnect_notify (void *cls, struct GNUNET_SERVER_Client *client)
2419 {
2420   struct Plugin *plugin = cls;
2421   struct Session *session;
2422
2423   if (client == NULL)
2424     return;
2425   session = lookup_session_by_client (plugin, client);
2426   if (session == NULL)
2427     return;                     /* unknown, nothing to do */
2428   LOG (GNUNET_ERROR_TYPE_DEBUG,
2429        "Destroying session of `%4s' with %s due to network-level disconnect.\n",
2430        GNUNET_i2s (&session->target),
2431        (session->addr !=
2432         NULL) ? tcp_address_to_string (session->plugin,
2433                                        session->addr,
2434                                        session->addrlen) :
2435        "*");
2436
2437   if (plugin->cur_connections == plugin->max_connections)
2438     GNUNET_SERVER_resume (plugin->server); /* Resume server  */
2439
2440   if (plugin->cur_connections < 1)
2441     GNUNET_break (0);
2442   else
2443     plugin->cur_connections--;
2444
2445   GNUNET_STATISTICS_update (session->plugin->env->stats,
2446                             gettext_noop
2447                             ("# network-level TCP disconnect events"), 1,
2448                             GNUNET_NO);
2449   tcp_disconnect_session (plugin, session);
2450 }
2451
2452
2453 /**
2454  * We can now send a probe message, copy into buffer to really send.
2455  *
2456  * @param cls closure, a struct TCPProbeContext
2457  * @param size max size to copy
2458  * @param buf buffer to copy message to
2459  * @return number of bytes copied into buf
2460  */
2461 static size_t
2462 notify_send_probe (void *cls, size_t size, void *buf)
2463 {
2464   struct TCPProbeContext *tcp_probe_ctx = cls;
2465   struct Plugin *plugin = tcp_probe_ctx->plugin;
2466   size_t ret;
2467
2468   tcp_probe_ctx->transmit_handle = NULL;
2469   GNUNET_CONTAINER_DLL_remove (plugin->probe_head, plugin->probe_tail,
2470                                tcp_probe_ctx);
2471   if (buf == NULL)
2472   {
2473     GNUNET_CONNECTION_destroy (tcp_probe_ctx->sock);
2474     GNUNET_free (tcp_probe_ctx);
2475     return 0;
2476   }
2477   GNUNET_assert (size >= sizeof (tcp_probe_ctx->message));
2478   memcpy (buf, &tcp_probe_ctx->message, sizeof (tcp_probe_ctx->message));
2479   GNUNET_SERVER_connect_socket (tcp_probe_ctx->plugin->server,
2480                                 tcp_probe_ctx->sock);
2481   ret = sizeof (tcp_probe_ctx->message);
2482   GNUNET_free (tcp_probe_ctx);
2483   return ret;
2484 }
2485
2486
2487 /**
2488  * Function called by the NAT subsystem suggesting another peer wants
2489  * to connect to us via connection reversal.  Try to connect back to the
2490  * given IP.
2491  *
2492  * @param cls closure
2493  * @param addr address to try
2494  * @param addrlen number of bytes in @a addr
2495  */
2496 static void
2497 try_connection_reversal (void *cls, const struct sockaddr *addr,
2498                          socklen_t addrlen)
2499 {
2500   struct Plugin *plugin = cls;
2501   struct GNUNET_CONNECTION_Handle *sock;
2502   struct TCPProbeContext *tcp_probe_ctx;
2503
2504   /**
2505    * We have received an ICMP response, ostensibly from a peer
2506    * that wants to connect to us! Send a message to establish a connection.
2507    */
2508   sock = GNUNET_CONNECTION_create_from_sockaddr (AF_INET, addr, addrlen);
2509   if (sock == NULL)
2510   {
2511     /* failed for some odd reason (out of sockets?); ignore attempt */
2512     return;
2513   }
2514
2515   /* FIXME: do we need to track these probe context objects so that
2516    * we can clean them up on plugin unload? */
2517   tcp_probe_ctx = GNUNET_malloc (sizeof (struct TCPProbeContext));
2518   tcp_probe_ctx->message.header.size =
2519       htons (sizeof (struct TCP_NAT_ProbeMessage));
2520   tcp_probe_ctx->message.header.type =
2521       htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE);
2522   memcpy (&tcp_probe_ctx->message.clientIdentity, plugin->env->my_identity,
2523           sizeof (struct GNUNET_PeerIdentity));
2524   tcp_probe_ctx->plugin = plugin;
2525   tcp_probe_ctx->sock = sock;
2526   GNUNET_CONTAINER_DLL_insert (plugin->probe_head, plugin->probe_tail,
2527                                tcp_probe_ctx);
2528   tcp_probe_ctx->transmit_handle =
2529       GNUNET_CONNECTION_notify_transmit_ready (sock,
2530                                                ntohs (tcp_probe_ctx->
2531                                                       message.header.size),
2532                                                GNUNET_TIME_UNIT_FOREVER_REL,
2533                                                &notify_send_probe,
2534                                                tcp_probe_ctx);
2535
2536 }
2537
2538
2539 /**
2540  * Function obtain the network type for a session
2541  *
2542  * @param cls closure ('struct Plugin*')
2543  * @param session the session
2544  * @return the network type in HBO or #GNUNET_SYSERR
2545  */
2546 static enum GNUNET_ATS_Network_Type
2547 tcp_get_network (void *cls,
2548                  struct Session *session)
2549 {
2550   GNUNET_assert (NULL != session);
2551   return session->ats_address_network_type;
2552 }
2553
2554
2555 /**
2556  * Entry point for the plugin.
2557  *
2558  * @param cls closure, the 'struct GNUNET_TRANSPORT_PluginEnvironment*'
2559  * @return the 'struct GNUNET_TRANSPORT_PluginFunctions*' or NULL on error
2560  */
2561 void *
2562 libgnunet_plugin_transport_tcp_init (void *cls)
2563 {
2564   static const struct GNUNET_SERVER_MessageHandler my_handlers[] = {
2565     {&handle_tcp_welcome, NULL, GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME,
2566      sizeof (struct WelcomeMessage)},
2567     {&handle_tcp_nat_probe, NULL, GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE,
2568      sizeof (struct TCP_NAT_ProbeMessage)},
2569     {&handle_tcp_data, NULL, GNUNET_MESSAGE_TYPE_ALL, 0},
2570     {NULL, NULL, 0, 0}
2571   };
2572   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
2573   struct GNUNET_TRANSPORT_PluginFunctions *api;
2574   struct Plugin *plugin;
2575   struct GNUNET_SERVICE_Context *service;
2576   unsigned long long aport;
2577   unsigned long long bport;
2578   unsigned long long max_connections;
2579   unsigned int i;
2580   struct GNUNET_TIME_Relative idle_timeout;
2581   int ret;
2582   int ret_s;
2583   struct sockaddr **addrs;
2584   socklen_t *addrlens;
2585
2586
2587   if (NULL == env->receive)
2588   {
2589     /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
2590        initialze the plugin or the API */
2591     api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
2592     api->cls = NULL;
2593     api->address_pretty_printer = &tcp_plugin_address_pretty_printer;
2594     api->address_to_string = &tcp_address_to_string;
2595     api->string_to_address = &tcp_string_to_address;
2596     return api;
2597   }
2598
2599   GNUNET_assert (NULL != env->cfg);
2600   if (GNUNET_OK !=
2601       GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp",
2602                                              "MAX_CONNECTIONS",
2603                                              &max_connections))
2604     max_connections = 128;
2605
2606   aport = 0;
2607   if ((GNUNET_OK !=
2608        GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp", "PORT",
2609                                               &bport)) || (bport > 65535) ||
2610       ((GNUNET_OK ==
2611         GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp",
2612                                                "ADVERTISED-PORT", &aport)) &&
2613        (aport > 65535)))
2614   {
2615     LOG (GNUNET_ERROR_TYPE_ERROR,
2616          _("Require valid port number for service `%s' in configuration!\n"),
2617          "transport-tcp");
2618     return NULL;
2619   }
2620   if (aport == 0)
2621     aport = bport;
2622   if (bport == 0)
2623     aport = 0;
2624   if (bport != 0)
2625   {
2626     service = GNUNET_SERVICE_start ("transport-tcp", env->cfg, GNUNET_SERVICE_OPTION_NONE);
2627     if (service == NULL)
2628     {
2629       LOG (GNUNET_ERROR_TYPE_WARNING,
2630            _("Failed to start service.\n"));
2631       return NULL;
2632     }
2633   }
2634   else
2635     service = NULL;
2636
2637   /* Initialize my flags */
2638   myoptions = 0;
2639
2640   plugin = GNUNET_new (struct Plugin);
2641   plugin->sessionmap = GNUNET_CONTAINER_multipeermap_create (max_connections, GNUNET_YES);
2642   plugin->max_connections = max_connections;
2643   plugin->cur_connections = 0;
2644   plugin->open_port = bport;
2645   plugin->adv_port = aport;
2646   plugin->env = env;
2647   plugin->lsock = NULL;
2648   if ((service != NULL) &&
2649       (GNUNET_SYSERR !=
2650        (ret_s =
2651         GNUNET_SERVICE_get_server_addresses ("transport-tcp", env->cfg, &addrs,
2652                                              &addrlens))))
2653   {
2654     for (ret = ret_s-1; ret >= 0; ret--)
2655       LOG (GNUNET_ERROR_TYPE_INFO,
2656            "Binding to address `%s'\n",
2657            GNUNET_a2s (addrs[ret], addrlens[ret]));
2658     plugin->nat =
2659         GNUNET_NAT_register (env->cfg, GNUNET_YES, aport, (unsigned int) ret_s,
2660                              (const struct sockaddr **) addrs, addrlens,
2661                              &tcp_nat_port_map_callback,
2662                              &try_connection_reversal, plugin);
2663     for (ret = ret_s -1; ret >= 0; ret--)
2664     {
2665       GNUNET_assert (addrs[ret] != NULL);
2666       GNUNET_free (addrs[ret]);
2667     }
2668     GNUNET_free_non_null (addrs);
2669     GNUNET_free_non_null (addrlens);
2670   }
2671   else
2672   {
2673     plugin->nat = GNUNET_NAT_register (plugin->env->cfg,
2674                                        GNUNET_YES, 0, 0, NULL, NULL, NULL,
2675                                        &try_connection_reversal, plugin);
2676   }
2677   api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
2678   api->cls = plugin;
2679   api->send = &tcp_plugin_send;
2680   api->get_session = &tcp_plugin_get_session;
2681
2682   api->disconnect_session = &tcp_disconnect_session;
2683   api->query_keepalive_factor = &tcp_query_keepalive_factor;
2684   api->disconnect_peer = &tcp_plugin_disconnect;
2685   api->address_pretty_printer = &tcp_plugin_address_pretty_printer;
2686   api->check_address = &tcp_plugin_check_address;
2687   api->address_to_string = &tcp_address_to_string;
2688   api->string_to_address = &tcp_string_to_address;
2689   api->get_network = &tcp_get_network;
2690   plugin->service = service;
2691   if (NULL != service)
2692   {
2693     plugin->server = GNUNET_SERVICE_get_server (service);
2694   }
2695   else
2696   {
2697     if (GNUNET_OK !=
2698         GNUNET_CONFIGURATION_get_value_time (env->cfg, "transport-tcp",
2699                                              "TIMEOUT", &idle_timeout))
2700     {
2701       GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2702                                  "transport-tcp", "TIMEOUT");
2703       if (plugin->nat != NULL)
2704         GNUNET_NAT_unregister (plugin->nat);
2705       GNUNET_free (plugin);
2706       GNUNET_free (api);
2707       return NULL;
2708     }
2709     plugin->server =
2710         GNUNET_SERVER_create_with_sockets (&plugin_tcp_access_check, plugin,
2711                                            NULL, idle_timeout, GNUNET_YES);
2712   }
2713   plugin->handlers = GNUNET_malloc (sizeof (my_handlers));
2714   memcpy (plugin->handlers, my_handlers, sizeof (my_handlers));
2715   for (i = 0;
2716        i < sizeof (my_handlers) / sizeof (struct GNUNET_SERVER_MessageHandler);
2717        i++)
2718     plugin->handlers[i].callback_cls = plugin;
2719
2720   GNUNET_SERVER_add_handlers (plugin->server, plugin->handlers);
2721   GNUNET_SERVER_disconnect_notify (plugin->server, &disconnect_notify, plugin);
2722   plugin->nat_wait_conns = GNUNET_CONTAINER_multipeermap_create (16, GNUNET_YES);
2723   if (bport != 0)
2724     LOG (GNUNET_ERROR_TYPE_INFO,
2725          _("TCP transport listening on port %llu\n"), bport);
2726   else
2727     LOG (GNUNET_ERROR_TYPE_INFO,
2728          _("TCP transport not listening on any port (client only)\n"));
2729   if (aport != bport)
2730     LOG (GNUNET_ERROR_TYPE_INFO,
2731          _("TCP transport advertises itself as being on port %llu\n"),
2732          aport);
2733   /* Initially set connections to 0 */
2734   GNUNET_assert (NULL != plugin->env->stats);
2735   GNUNET_STATISTICS_set (plugin->env->stats,
2736                          gettext_noop ("# TCP sessions active"), 0,
2737                          GNUNET_NO);
2738   return api;
2739 }
2740
2741
2742 /**
2743  * Exit point from the plugin.
2744  */
2745 void *
2746 libgnunet_plugin_transport_tcp_done (void *cls)
2747 {
2748   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
2749   struct Plugin *plugin = api->cls;
2750   struct TCPProbeContext *tcp_probe;
2751   struct PrettyPrinterContext *cur;
2752   struct PrettyPrinterContext *next;
2753
2754   if (NULL == plugin)
2755   {
2756     GNUNET_free (api);
2757     return NULL;
2758   }
2759   LOG (GNUNET_ERROR_TYPE_DEBUG,
2760        "Shutting down TCP plugin\n");
2761
2762   /* Removing leftover sessions */
2763   GNUNET_CONTAINER_multipeermap_iterate (plugin->sessionmap,
2764                                          &session_disconnect_it, plugin);
2765   /* Removing leftover NAT sessions */
2766   GNUNET_CONTAINER_multipeermap_iterate (plugin->nat_wait_conns,
2767                                          &session_disconnect_it, plugin);
2768
2769   next = ppc_dll_head;
2770   for (cur = next; NULL != cur; cur = next)
2771   {
2772     next = cur->next;
2773     GNUNET_CONTAINER_DLL_remove (ppc_dll_head, ppc_dll_tail, cur);
2774     if (NULL != cur->resolver_handle)
2775       GNUNET_RESOLVER_request_cancel (cur->resolver_handle);
2776     GNUNET_SCHEDULER_cancel (cur->timeout_task);
2777     GNUNET_free (cur);
2778     GNUNET_break (0);
2779   }
2780
2781   if (plugin->service != NULL)
2782     GNUNET_SERVICE_stop (plugin->service);
2783   else
2784     GNUNET_SERVER_destroy (plugin->server);
2785   GNUNET_free (plugin->handlers);
2786   if (plugin->nat != NULL)
2787     GNUNET_NAT_unregister (plugin->nat);
2788   while (NULL != (tcp_probe = plugin->probe_head))
2789   {
2790     GNUNET_CONTAINER_DLL_remove (plugin->probe_head, plugin->probe_tail,
2791                                  tcp_probe);
2792     GNUNET_CONNECTION_destroy (tcp_probe->sock);
2793     GNUNET_free (tcp_probe);
2794   }
2795   GNUNET_CONTAINER_multipeermap_destroy (plugin->nat_wait_conns);
2796   GNUNET_CONTAINER_multipeermap_destroy (plugin->sessionmap);
2797   GNUNET_free (plugin);
2798   GNUNET_free (api);
2799   return NULL;
2800 }
2801
2802 /* end of plugin_transport_tcp.c */