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