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