src/transport/plugin_transport_tcp.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 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 DEBUG_TCP GNUNET_EXTRA_LOGGING
  43
  44 #define DEBUG_TCP_NAT GNUNET_EXTRA_LOGGING
  45
  46 /**
  47  * Initial handshake message for a session.
  48  */
  49 struct WelcomeMessage
  50 {
  51   /**
  52    * Type is GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME.
  53    */
  54   struct GNUNET_MessageHeader header;
  55
  56   /**
  57    * Identity of the node connecting (TCP client)
  58    */
  59   struct GNUNET_PeerIdentity clientIdentity;
  60
  61 };
  62
  63
  64 /**
  65  * Basically a WELCOME message, but with the purpose
  66  * of giving the waiting peer a client handle to use
  67  */
  68 struct TCP_NAT_ProbeMessage
  69 {
  70   /**
  71    * Type is GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE.
  72    */
  73   struct GNUNET_MessageHeader header;
  74
  75   /**
  76    * Identity of the sender of the message.
  77    */
  78   struct GNUNET_PeerIdentity clientIdentity;
  79
  80 };
  81
  82
  83 /**
  84  * Context for sending a NAT probe via TCP.
  85  */
  86 struct TCPProbeContext
  87 {
  88
  89   /**
  90    * Active probes are kept in a DLL.
  91    */
  92   struct TCPProbeContext *next;
  93
  94   /**
  95    * Active probes are kept in a DLL.
  96    */
  97   struct TCPProbeContext *prev;
  98
  99   /**
 100    * Probe connection.
 101    */
 102   struct GNUNET_CONNECTION_Handle *sock;
 103
 104   /**
 105    * Message to be sent.
 106    */
 107   struct TCP_NAT_ProbeMessage message;
 108
 109   /**
 110    * Handle to the transmission.
 111    */
 112   struct GNUNET_CONNECTION_TransmitHandle *transmit_handle;
 113
 114   /**
 115    * Transport plugin handle.
 116    */
 117   struct Plugin *plugin;
 118 };
 119
 120
 121 /**
 122  * Network format for IPv4 addresses.
 123  */
 124 struct IPv4TcpAddress
 125 {
 126   /**
 127    * IPv4 address, in network byte order.
 128    */
 129   uint32_t ipv4_addr GNUNET_PACKED;
 130
 131   /**
 132    * Port number, in network byte order.
 133    */
 134   uint16_t t4_port GNUNET_PACKED;
 135
 136 };
 137
 138
 139 /**
 140  * Network format for IPv6 addresses.
 141  */
 142 struct IPv6TcpAddress
 143 {
 144   /**
 145    * IPv6 address.
 146    */
 147   struct in6_addr ipv6_addr GNUNET_PACKED;
 148
 149   /**
 150    * Port number, in network byte order.
 151    */
 152   uint16_t t6_port GNUNET_PACKED;
 153
 154 };
 155
 156
 157 /**
 158  * Encapsulation of all of the state of the plugin.
 159  */
 160 struct Plugin;
 161
 162
 163 /**
 164  * Information kept for each message that is yet to
 165  * be transmitted.
 166  */
 167 struct PendingMessage
 168 {
 169
 170   /**
 171    * This is a doubly-linked list.
 172    */
 173   struct PendingMessage *next;
 174
 175   /**
 176    * This is a doubly-linked list.
 177    */
 178   struct PendingMessage *prev;
 179
 180   /**
 181    * The pending message
 182    */
 183   const char *msg;
 184
 185   /**
 186    * Continuation function to call once the message
 187    * has been sent.  Can be NULL if there is no
 188    * continuation to call.
 189    */
 190   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
 191
 192   /**
 193    * Closure for transmit_cont.
 194    */
 195   void *transmit_cont_cls;
 196
 197   /**
 198    * Timeout value for the pending message.
 199    */
 200   struct GNUNET_TIME_Absolute timeout;
 201
 202   /**
 203    * So that the gnunet-service-transport can group messages together,
 204    * these pending messages need to accept a message buffer and size
 205    * instead of just a GNUNET_MessageHeader.
 206    */
 207   size_t message_size;
 208
 209 };
 210
 211
 212 /**
 213  * Session handle for TCP connections.
 214  */
 215 struct Session
 216 {
 217
 218   /**
 219    * API requirement.
 220    */
 221   struct SessionHeader header;
 222
 223   /**
 224    * Stored in a linked list.
 225    */
 226   struct Session *next;
 227
 228   /**
 229    * Pointer to the global plugin struct.
 230    */
 231   struct Plugin *plugin;
 232
 233   /**
 234    * The client (used to identify this connection)
 235    */
 236   struct GNUNET_SERVER_Client *client;
 237
 238   /**
 239    * Messages currently pending for transmission
 240    * to this peer, if any.
 241    */
 242   struct PendingMessage *pending_messages_head;
 243
 244   /**
 245    * Messages currently pending for transmission
 246    * to this peer, if any.
 247    */
 248   struct PendingMessage *pending_messages_tail;
 249
 250   /**
 251    * Handle for pending transmission request.
 252    */
 253   struct GNUNET_CONNECTION_TransmitHandle *transmit_handle;
 254
 255   /**
 256    * To whom are we talking to (set to our identity
 257    * if we are still waiting for the welcome message)
 258    */
 259   struct GNUNET_PeerIdentity target;
 260
 261   /**
 262    * ID of task used to delay receiving more to throttle sender.
 263    */
 264   GNUNET_SCHEDULER_TaskIdentifier receive_delay_task;
 265
 266   /**
 267    * Address of the other peer (either based on our 'connect'
 268    * call or on our 'accept' call).
 269    */
 270   void *connect_addr;
 271
 272   /**
 273    * Last activity on this connection.  Used to select preferred
 274    * connection.
 275    */
 276   struct GNUNET_TIME_Absolute last_activity;
 277
 278   /**
 279    * Length of connect_addr.
 280    */
 281   size_t connect_alen;
 282
 283   /**
 284    * Are we still expecting the welcome message? (GNUNET_YES/GNUNET_NO)
 285    */
 286   int expecting_welcome;
 287
 288   /**
 289    * Was this a connection that was inbound (we accepted)? (GNUNET_YES/GNUNET_NO)
 290    */
 291   int inbound;
 292
 293   /**
 294    * Was this session created using NAT traversal?
 295    */
 296   int is_nat;
 297
 298 };
 299
 300
 301 /**
 302  * Encapsulation of all of the state of the plugin.
 303  */
 304 struct Plugin
 305 {
 306   /**
 307    * Our environment.
 308    */
 309   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 310
 311   /**
 312    * The listen socket.
 313    */
 314   struct GNUNET_CONNECTION_Handle *lsock;
 315
 316   /**
 317    * Our handle to the NAT module.
 318    */
 319   struct GNUNET_NAT_Handle *nat;
 320
 321   /**
 322    * List of open TCP sessions.
 323    */
 324   struct Session *sessions;
 325
 326   /**
 327    * Handle to the network service.
 328    */
 329   struct GNUNET_SERVICE_Context *service;
 330
 331   /**
 332    * Handle to the server for this service.
 333    */
 334   struct GNUNET_SERVER_Handle *server;
 335
 336   /**
 337    * Copy of the handler array where the closures are
 338    * set to this struct's instance.
 339    */
 340   struct GNUNET_SERVER_MessageHandler *handlers;
 341
 342   /**
 343    * Map of peers we have tried to contact behind a NAT
 344    */
 345   struct GNUNET_CONTAINER_MultiHashMap *nat_wait_conns;
 346
 347   /**
 348    * List of active TCP probes.
 349    */
 350   struct TCPProbeContext *probe_head;
 351
 352   /**
 353    * List of active TCP probes.
 354    */
 355   struct TCPProbeContext *probe_tail;
 356
 357   /**
 358    * Handle for (DYN)DNS lookup of our external IP.
 359    */
 360   struct GNUNET_RESOLVER_RequestHandle *ext_dns;
 361
 362   /**
 363    * How many more TCP sessions are we allowed to open right now?
 364    */
 365   unsigned long long max_connections;
 366
 367   /**
 368    * ID of task used to update our addresses when one expires.
 369    */
 370   GNUNET_SCHEDULER_TaskIdentifier address_update_task;
 371
 372   /**
 373    * Port that we are actually listening on.
 374    */
 375   uint16_t open_port;
 376
 377   /**
 378    * Port that the user said we would have visible to the
 379    * rest of the world.
 380    */
 381   uint16_t adv_port;
 382
 383 };
 384
 385
 386 /**
 387  * Function to check if an inbound connection is acceptable.
 388  * Mostly used to limit the total number of open connections
 389  * we can have.
 390  *
 391  * @param cls the 'struct Plugin'
 392  * @param ucred credentials, if available, otherwise NULL
 393  * @param addr address
 394  * @param addrlen length of address
 395  * @return GNUNET_YES to allow, GNUNET_NO to deny, GNUNET_SYSERR
 396  *   for unknown address family (will be denied).
 397  */
 398 static int
 399 plugin_tcp_access_check (void *cls,
 400                          const struct GNUNET_CONNECTION_Credentials *ucred,
 401                          const struct sockaddr *addr, socklen_t addrlen)
 402 {
 403   struct Plugin *plugin = cls;
 404
 405   if (0 == plugin->max_connections)
 406     return GNUNET_NO;
 407   plugin->max_connections--;
 408   return GNUNET_YES;
 409 }
 410
 411
 412 /**
 413  * Our external IP address/port mapping has changed.
 414  *
 415  * @param cls closure, the 'struct LocalAddrList'
 416  * @param add_remove GNUNET_YES to mean the new public IP address, GNUNET_NO to mean
 417  *     the previous (now invalid) one
 418  * @param addr either the previous or the new public IP address
 419  * @param addrlen actual lenght of the address
 420  */
 421 static void
 422 tcp_nat_port_map_callback (void *cls, int add_remove,
 423                            const struct sockaddr *addr, socklen_t addrlen)
 424 {
 425   struct Plugin *plugin = cls;
 426   struct IPv4TcpAddress t4;
 427   struct IPv6TcpAddress t6;
 428   void *arg;
 429   size_t args;
 430
 431   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
 432                    "NPMC called with %d for address `%s'\n", add_remove,
 433                    GNUNET_a2s (addr, addrlen));
 434   /* convert 'addr' to our internal format */
 435   switch (addr->sa_family)
 436   {
 437   case AF_INET:
 438     GNUNET_assert (addrlen == sizeof (struct sockaddr_in));
 439     t4.ipv4_addr = ((struct sockaddr_in *) addr)->sin_addr.s_addr;
 440     t4.t4_port = ((struct sockaddr_in *) addr)->sin_port;
 441     arg = &t4;
 442     args = sizeof (t4);
 443     break;
 444   case AF_INET6:
 445     GNUNET_assert (addrlen == sizeof (struct sockaddr_in6));
 446     memcpy (&t6.ipv6_addr, &((struct sockaddr_in6 *) addr)->sin6_addr,
 447             sizeof (struct in6_addr));
 448     t6.t6_port = ((struct sockaddr_in6 *) addr)->sin6_port;
 449     arg = &t6;
 450     args = sizeof (t6);
 451     break;
 452   default:
 453     GNUNET_break (0);
 454     return;
 455   }
 456   /* modify our published address list */
 457   plugin->env->notify_address (plugin->env->cls, add_remove, arg, args);
 458 }
 459
 460
 461 /**
 462  * Function called for a quick conversion of the binary address to
 463  * a numeric address.  Note that the caller must not free the
 464  * address and that the next call to this function is allowed
 465  * to override the address again.
 466  *
 467  * @param cls closure ('struct Plugin*')
 468  * @param addr binary address
 469  * @param addrlen length of the address
 470  * @return string representing the same address
 471  */
 472 static const char *
 473 tcp_address_to_string (void *cls, const void *addr, size_t addrlen)
 474 {
 475   static char rbuf[INET6_ADDRSTRLEN + 12];
 476   char buf[INET6_ADDRSTRLEN];
 477   const void *sb;
 478   struct in_addr a4;
 479   struct in6_addr a6;
 480   const struct IPv4TcpAddress *t4;
 481   const struct IPv6TcpAddress *t6;
 482   int af;
 483   uint16_t port;
 484
 485   if (addrlen == sizeof (struct IPv6TcpAddress))
 486   {
 487     t6 = addr;
 488     af = AF_INET6;
 489     port = ntohs (t6->t6_port);
 490     memcpy (&a6, &t6->ipv6_addr, sizeof (a6));
 491     sb = &a6;
 492   }
 493   else if (addrlen == sizeof (struct IPv4TcpAddress))
 494   {
 495     t4 = addr;
 496     af = AF_INET;
 497     port = ntohs (t4->t4_port);
 498     memcpy (&a4, &t4->ipv4_addr, sizeof (a4));
 499     sb = &a4;
 500   }
 501   else
 502   {
 503     GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "tcp",
 504                      _("Unexpected address length: %u bytes\n"),
 505                      (unsigned int) addrlen);
 506     GNUNET_break (0);
 507     return NULL;
 508   }
 509   if (NULL == inet_ntop (af, sb, buf, INET6_ADDRSTRLEN))
 510   {
 511     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "inet_ntop");
 512     return NULL;
 513   }
 514   GNUNET_snprintf (rbuf, sizeof (rbuf), (af == AF_INET6) ? "[%s]:%u" : "%s:%u",
 515                    buf, port);
 516   return rbuf;
 517 }
 518
 519
 520 /**
 521  * Find the session handle for the given client.
 522  *
 523  * @param plugin the plugin
 524  * @param client which client to find the session handle for
 525  * @return NULL if no matching session exists
 526  */
 527 static struct Session *
 528 find_session_by_client (struct Plugin *plugin,
 529                         const struct GNUNET_SERVER_Client *client)
 530 {
 531   struct Session *ret;
 532
 533   ret = plugin->sessions;
 534   while ((ret != NULL) && (client != ret->client))
 535     ret = ret->next;
 536   return ret;
 537 }
 538
 539
 540 /**
 541  * Create a new session.  Also queues a welcome message.
 542  *
 543  * @param plugin the plugin
 544  * @param target peer to connect to
 545  * @param client client to use
 546  * @param is_nat this a NAT session, we should wait for a client to
 547  *               connect to us from an address, then assign that to
 548  *               the session
 549  * @return new session object
 550  */
 551 static struct Session *
 552 create_session (struct Plugin *plugin, const struct GNUNET_PeerIdentity *target,
 553                 struct GNUNET_SERVER_Client *client, int is_nat)
 554 {
 555   struct Session *ret;
 556   struct PendingMessage *pm;
 557   struct WelcomeMessage welcome;
 558
 559   if (is_nat != GNUNET_YES)
 560     GNUNET_assert (client != NULL);
 561   else
 562     GNUNET_assert (client == NULL);
 563 #if DEBUG_TCP
 564   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
 565                    "Creating new session for peer `%4s'\n",
 566                    GNUNET_i2s (target));
 567 #endif
 568   ret = GNUNET_malloc (sizeof (struct Session));
 569   ret->last_activity = GNUNET_TIME_absolute_get ();
 570   ret->plugin = plugin;
 571   ret->is_nat = is_nat;
 572   if (is_nat != GNUNET_YES)     /* If not a NAT WAIT conn, add it to global list */
 573   {
 574     ret->next = plugin->sessions;
 575     plugin->sessions = ret;
 576   }
 577   ret->client = client;
 578   ret->target = *target;
 579   ret->expecting_welcome = GNUNET_YES;
 580   pm = GNUNET_malloc (sizeof (struct PendingMessage) +
 581                       sizeof (struct WelcomeMessage));
 582   pm->msg = (const char *) &pm[1];
 583   pm->message_size = sizeof (struct WelcomeMessage);
 584   welcome.header.size = htons (sizeof (struct WelcomeMessage));
 585   welcome.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME);
 586   welcome.clientIdentity = *plugin->env->my_identity;
 587   memcpy (&pm[1], &welcome, sizeof (welcome));
 588   pm->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
 589   GNUNET_STATISTICS_update (plugin->env->stats,
 590                             gettext_noop ("# bytes currently in TCP buffers"),
 591                             pm->message_size, GNUNET_NO);
 592   GNUNET_CONTAINER_DLL_insert (ret->pending_messages_head,
 593                                ret->pending_messages_tail, pm);
 594   if (is_nat != GNUNET_YES)
 595     GNUNET_STATISTICS_update (plugin->env->stats,
 596                               gettext_noop ("# TCP sessions active"), 1,
 597                               GNUNET_NO);
 598   return ret;
 599 }
 600
 601
 602 /**
 603  * If we have pending messages, ask the server to
 604  * transmit them (schedule the respective tasks, etc.)
 605  *
 606  * @param session for which session should we do this
 607  */
 608 static void
 609 process_pending_messages (struct Session *session);
 610
 611
 612 /**
 613  * Function called to notify a client about the socket
 614  * being ready to queue more data.  "buf" will be
 615  * NULL and "size" zero if the socket was closed for
 616  * writing in the meantime.
 617  *
 618  * @param cls closure
 619  * @param size number of bytes available in buf
 620  * @param buf where the callee should write the message
 621  * @return number of bytes written to buf
 622  */
 623 static size_t
 624 do_transmit (void *cls, size_t size, void *buf)
 625 {
 626   struct Session *session = cls;
 627   struct GNUNET_PeerIdentity pid;
 628   struct Plugin *plugin;
 629   struct PendingMessage *pos;
 630   struct PendingMessage *hd;
 631   struct PendingMessage *tl;
 632   struct GNUNET_TIME_Absolute now;
 633   char *cbuf;
 634   size_t ret;
 635
 636   GNUNET_assert (session != NULL);
 637   session->transmit_handle = NULL;
 638   plugin = session->plugin;
 639   if (buf == NULL)
 640   {
 641 #if DEBUG_TCP
 642     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
 643                      "Timeout trying to transmit to peer `%4s', discarding message queue.\n",
 644                      GNUNET_i2s (&session->target));
 645 #endif
 646     /* timeout; cancel all messages that have already expired */
 647     hd = NULL;
 648     tl = NULL;
 649     ret = 0;
 650     now = GNUNET_TIME_absolute_get ();
 651     while ((NULL != (pos = session->pending_messages_head)) &&
 652            (pos->timeout.abs_value <= now.abs_value))
 653     {
 654       GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
 655                                    session->pending_messages_tail, pos);
 656 #if DEBUG_TCP
 657       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
 658                        "Failed to transmit %u byte message to `%4s'.\n",
 659                        pos->message_size, GNUNET_i2s (&session->target));
 660 #endif
 661       ret += pos->message_size;
 662       GNUNET_CONTAINER_DLL_insert_after (hd, tl, tl, pos);
 663     }
 664     /* do this call before callbacks (so that if callbacks destroy
 665      * session, they have a chance to cancel actions done by this
 666      * call) */
 667     process_pending_messages (session);
 668     pid = session->target;
 669     /* no do callbacks and do not use session again since
 670      * the callbacks may abort the session */
 671     while (NULL != (pos = hd))
 672     {
 673       GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
 674       if (pos->transmit_cont != NULL)
 675         pos->transmit_cont (pos->transmit_cont_cls, &pid, GNUNET_SYSERR);
 676       GNUNET_free (pos);
 677     }
 678     GNUNET_STATISTICS_update (plugin->env->stats,
 679                               gettext_noop ("# bytes currently in TCP buffers"),
 680                               -(int64_t) ret, GNUNET_NO);
 681     GNUNET_STATISTICS_update (plugin->env->stats,
 682                               gettext_noop
 683                               ("# bytes discarded by TCP (timeout)"), ret,
 684                               GNUNET_NO);
 685     return 0;
 686   }
 687   /* copy all pending messages that would fit */
 688   ret = 0;
 689   cbuf = buf;
 690   hd = NULL;
 691   tl = NULL;
 692   while (NULL != (pos = session->pending_messages_head))
 693   {
 694     if (ret + pos->message_size > size)
 695       break;
 696     GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
 697                                  session->pending_messages_tail, pos);
 698     GNUNET_assert (size >= pos->message_size);
 699     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 700                      "tcp",
 701                      "Transmitting message of type %u\n",
 702                      ntohs (((struct GNUNET_MessageHeader*)pos->msg)->type));
 703     /* FIXME: this memcpy can be up to 7% of our total runtime */
 704     memcpy (cbuf, pos->msg, pos->message_size);
 705     cbuf += pos->message_size;
 706     ret += pos->message_size;
 707     size -= pos->message_size;
 708     GNUNET_CONTAINER_DLL_insert_tail (hd, tl, pos);
 709   }
 710   /* schedule 'continuation' before callbacks so that callbacks that
 711    * cancel everything don't cause us to use a session that no longer
 712    * exists... */
 713   process_pending_messages (session);
 714   session->last_activity = GNUNET_TIME_absolute_get ();
 715   pid = session->target;
 716   /* we'll now call callbacks that may cancel the session; hence
 717    * we should not use 'session' after this point */
 718   while (NULL != (pos = hd))
 719   {
 720     GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
 721     if (pos->transmit_cont != NULL)
 722       pos->transmit_cont (pos->transmit_cont_cls, &pid, GNUNET_OK);
 723     GNUNET_free (pos);
 724   }
 725   GNUNET_assert (hd == NULL);
 726   GNUNET_assert (tl == NULL);
 727 #if DEBUG_TCP > 1
 728   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp", "Transmitting %u bytes\n",
 729                    ret);
 730 #endif
 731   GNUNET_STATISTICS_update (plugin->env->stats,
 732                             gettext_noop ("# bytes currently in TCP buffers"),
 733                             -(int64_t) ret, GNUNET_NO);
 734   GNUNET_STATISTICS_update (plugin->env->stats,
 735                             gettext_noop ("# bytes transmitted via TCP"), ret,
 736                             GNUNET_NO);
 737   return ret;
 738 }
 739
 740
 741 /**
 742  * If we have pending messages, ask the server to
 743  * transmit them (schedule the respective tasks, etc.)
 744  *
 745  * @param session for which session should we do this
 746  */
 747 static void
 748 process_pending_messages (struct Session *session)
 749 {
 750   struct PendingMessage *pm;
 751
 752   GNUNET_assert (session->client != NULL);
 753   if (session->transmit_handle != NULL)
 754     return;
 755   if (NULL == (pm = session->pending_messages_head))
 756     return;
 757
 758   session->transmit_handle =
 759       GNUNET_SERVER_notify_transmit_ready (session->client, pm->message_size,
 760                                            GNUNET_TIME_absolute_get_remaining
 761                                            (pm->timeout), &do_transmit,
 762                                            session);
 763 }
 764
 765
 766 /**
 767  * Functions with this signature are called whenever we need
 768  * to close a session due to a disconnect or failure to
 769  * establish a connection.
 770  *
 771  * @param session session to close down
 772  */
 773 static void
 774 disconnect_session (struct Session *session)
 775 {
 776   struct Session *prev;
 777   struct Session *pos;
 778   struct PendingMessage *pm;
 779
 780 #if DEBUG_TCP
 781   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
 782                    "Disconnecting from `%4s' at %s.\n",
 783                    GNUNET_i2s (&session->target),
 784                    (session->connect_addr !=
 785                     NULL) ? tcp_address_to_string (session->plugin,
 786                                                    session->connect_addr,
 787                                                    session->connect_alen) :
 788                    "*");
 789 #endif
 790   /* remove from session list */
 791   prev = NULL;
 792   pos = session->plugin->sessions;
 793   while (pos != session)
 794   {
 795     prev = pos;
 796     pos = pos->next;
 797   }
 798   if (prev == NULL)
 799     session->plugin->sessions = session->next;
 800   else
 801     prev->next = session->next;
 802
 803   /* clean up state */
 804   if (session->transmit_handle != NULL)
 805   {
 806     GNUNET_CONNECTION_notify_transmit_ready_cancel (session->transmit_handle);
 807     session->transmit_handle = NULL;
 808   }
 809   session->plugin->env->session_end (session->plugin->env->cls,
 810                                      &session->target, session);
 811   while (NULL != (pm = session->pending_messages_head))
 812   {
 813 #if DEBUG_TCP
 814     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
 815                      pm->transmit_cont !=
 816                      NULL ? "Could not deliver message to `%4s'.\n" :
 817                      "Could not deliver message to `%4s', notifying.\n",
 818                      GNUNET_i2s (&session->target));
 819 #endif
 820     GNUNET_STATISTICS_update (session->plugin->env->stats,
 821                               gettext_noop ("# bytes currently in TCP buffers"),
 822                               -(int64_t) pm->message_size, GNUNET_NO);
 823     GNUNET_STATISTICS_update (session->plugin->env->stats,
 824                               gettext_noop
 825                               ("# bytes discarded by TCP (disconnect)"),
 826                               pm->message_size, GNUNET_NO);
 827     GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
 828                                  session->pending_messages_tail, pm);
 829     if (NULL != pm->transmit_cont)
 830       pm->transmit_cont (pm->transmit_cont_cls, &session->target,
 831                          GNUNET_SYSERR);
 832     GNUNET_free (pm);
 833   }
 834   GNUNET_break (session->client != NULL);
 835   if (session->receive_delay_task != GNUNET_SCHEDULER_NO_TASK)
 836   {
 837     GNUNET_SCHEDULER_cancel (session->receive_delay_task);
 838     if (session->client != NULL)
 839       GNUNET_SERVER_receive_done (session->client, GNUNET_SYSERR);
 840   }
 841   if (session->client != NULL)
 842   {
 843     GNUNET_SERVER_client_drop (session->client);
 844     session->client = NULL;
 845   }
 846   GNUNET_STATISTICS_update (session->plugin->env->stats,
 847                             gettext_noop ("# TCP sessions active"), -1,
 848                             GNUNET_NO);
 849   GNUNET_free_non_null (session->connect_addr);
 850   GNUNET_assert (NULL == session->transmit_handle);
 851   GNUNET_free (session);
 852 }
 853
 854
 855 /**
 856  * Given two otherwise equivalent sessions, pick the better one.
 857  *
 858  * @param s1 one session (also default)
 859  * @param s2 other session
 860  * @return "better" session (more active)
 861  */
 862 static struct Session *
 863 select_better_session (struct Session *s1, struct Session *s2)
 864 {
 865   if (s1 == NULL)
 866     return s2;
 867   if (s2 == NULL)
 868     return s1;
 869   if ((s1->expecting_welcome == GNUNET_NO) &&
 870       (s2->expecting_welcome == GNUNET_YES))
 871     return s1;
 872   if ((s1->expecting_welcome == GNUNET_YES) &&
 873       (s2->expecting_welcome == GNUNET_NO))
 874     return s2;
 875   if (s1->last_activity.abs_value < s2->last_activity.abs_value)
 876     return s2;
 877   if (s1->last_activity.abs_value > s2->last_activity.abs_value)
 878     return s1;
 879   if ((GNUNET_YES == s1->inbound) && (GNUNET_NO == s2->inbound))
 880     return s1;
 881   if ((GNUNET_NO == s1->inbound) && (GNUNET_YES == s2->inbound))
 882     return s2;
 883   return s1;
 884 }
 885
 886
 887
 888 /**
 889  * Function that can be used by the transport service to transmit
 890  * a message using the plugin.   Note that in the case of a
 891  * peer disconnecting, the continuation MUST be called
 892  * prior to the disconnect notification itself.  This function
 893  * will be called with this peer's HELLO message to initiate
 894  * a fresh connection to another peer.
 895  *
 896  * @param cls closure
 897  * @param target who should receive this message
 898  * @param msg the message to transmit
 899  * @param msgbuf_size number of bytes in 'msg'
 900  * @param priority how important is the message (most plugins will
 901  *                 ignore message priority and just FIFO)
 902  * @param timeout how long to wait at most for the transmission (does not
 903  *                require plugins to discard the message after the timeout,
 904  *                just advisory for the desired delay; most plugins will ignore
 905  *                this as well)
 906  * @param session which session must be used (or NULL for "any")
 907  * @param addr the address to use (can be NULL if the plugin
 908  *                is "on its own" (i.e. re-use existing TCP connection))
 909  * @param addrlen length of the address in bytes
 910  * @param force_address GNUNET_YES if the plugin MUST use the given address,
 911  *                GNUNET_NO means the plugin may use any other address and
 912  *                GNUNET_SYSERR means that only reliable existing
 913  *                bi-directional connections should be used (regardless
 914  *                of address)
 915  * @param cont continuation to call once the message has
 916  *        been transmitted (or if the transport is ready
 917  *        for the next transmission call; or if the
 918  *        peer disconnected...); can be NULL
 919  * @param cont_cls closure for cont
 920  * @return number of bytes used (on the physical network, with overheads);
 921  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
 922  *         and does NOT mean that the message was not transmitted (DV and NAT)
 923  */
 924 static ssize_t
 925 tcp_plugin_send (void *cls, const struct GNUNET_PeerIdentity *target,
 926                  const char *msg, size_t msgbuf_size, uint32_t priority,
 927                  struct GNUNET_TIME_Relative timeout, struct Session *session,
 928                  const void *addr, size_t addrlen, int force_address,
 929                  GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
 930 {
 931   struct Plugin *plugin = cls;
 932   struct Session *cand_session;
 933   struct Session *next;
 934   struct PendingMessage *pm;
 935   struct GNUNET_CONNECTION_Handle *sa;
 936   int af;
 937   const void *sb;
 938   size_t sbs;
 939   struct sockaddr_in a4;
 940   struct sockaddr_in6 a6;
 941   const struct IPv4TcpAddress *t4;
 942   const struct IPv6TcpAddress *t6;
 943   unsigned int is_natd;
 944
 945   GNUNET_STATISTICS_update (plugin->env->stats,
 946                             gettext_noop ("# bytes TCP was asked to transmit"),
 947                             msgbuf_size, GNUNET_NO);
 948   /* FIXME: we could do this cheaper with a hash table
 949    * where we could restrict the iteration to entries that match
 950    * the target peer... */
 951   is_natd = GNUNET_NO;
 952   if (session == NULL)
 953   {
 954     cand_session = NULL;
 955     next = plugin->sessions;
 956     while (NULL != (session = next))
 957     {
 958       next = session->next;
 959       GNUNET_assert (session->client != NULL);
 960       if (0 !=
 961           memcmp (target, &session->target,
 962                   sizeof (struct GNUNET_PeerIdentity)))
 963         continue;
 964       if (((GNUNET_SYSERR == force_address) &&
 965            (session->expecting_welcome == GNUNET_NO)) ||
 966           (GNUNET_NO == force_address))
 967       {
 968         cand_session = select_better_session (cand_session, session);
 969         continue;
 970       }
 971       if (GNUNET_SYSERR == force_address)
 972         continue;
 973       GNUNET_break (GNUNET_YES == force_address);
 974       if (addr == NULL)
 975       {
 976         GNUNET_break (0);
 977         break;
 978       }
 979       if ((addrlen != session->connect_alen) && (session->is_nat == GNUNET_NO))
 980         continue;
 981       if ((0 != memcmp (session->connect_addr, addr, addrlen)) &&
 982           (session->is_nat == GNUNET_NO))
 983         continue;
 984       cand_session = select_better_session (cand_session, session);
 985     }
 986     session = cand_session;
 987   }
 988   if ((session == NULL) && (addrlen == 0))
 989   {
 990 #if DEBUG_TCP
 991     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
 992                      "Asked to transmit to `%4s' without address and I have no existing connection (failing).\n",
 993                      GNUNET_i2s (target));
 994 #endif
 995     GNUNET_STATISTICS_update (plugin->env->stats,
 996                               gettext_noop
 997                               ("# bytes discarded by TCP (no address and no connection)"),
 998                               msgbuf_size, GNUNET_NO);
 999     return -1;
1000   }
1001   if (session == NULL)
1002   {
1003     if (addrlen == sizeof (struct IPv6TcpAddress))
1004     {
1005       t6 = addr;
1006       af = AF_INET6;
1007       memset (&a6, 0, sizeof (a6));
1008 #if HAVE_SOCKADDR_IN_SIN_LEN
1009       a6.sin6_len = sizeof (a6);
1010 #endif
1011       a6.sin6_family = AF_INET6;
1012       a6.sin6_port = t6->t6_port;
1013       if (t6->t6_port == 0)
1014         is_natd = GNUNET_YES;
1015       memcpy (&a6.sin6_addr, &t6->ipv6_addr, sizeof (struct in6_addr));
1016       sb = &a6;
1017       sbs = sizeof (a6);
1018     }
1019     else if (addrlen == sizeof (struct IPv4TcpAddress))
1020     {
1021       t4 = addr;
1022       af = AF_INET;
1023       memset (&a4, 0, sizeof (a4));
1024 #if HAVE_SOCKADDR_IN_SIN_LEN
1025       a4.sin_len = sizeof (a4);
1026 #endif
1027       a4.sin_family = AF_INET;
1028       a4.sin_port = t4->t4_port;
1029       if (t4->t4_port == 0)
1030         is_natd = GNUNET_YES;
1031       a4.sin_addr.s_addr = t4->ipv4_addr;
1032       sb = &a4;
1033       sbs = sizeof (a4);
1034     }
1035     else
1036     {
1037       GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "tcp",
1038                        _("Address of unexpected length: %u\n"), addrlen);
1039       GNUNET_break (0);
1040       return -1;
1041     }
1042
1043     if ((is_natd == GNUNET_YES) && (addrlen == sizeof (struct IPv6TcpAddress)))
1044       return -1;                /* NAT client only works with IPv4 addresses */
1045     if (0 == plugin->max_connections)
1046       return -1;                /* saturated */
1047
1048     if ((is_natd == GNUNET_YES) && (NULL != plugin->nat) &&
1049         (GNUNET_NO ==
1050          GNUNET_CONTAINER_multihashmap_contains (plugin->nat_wait_conns,
1051                                                  &target->hashPubKey)))
1052     {
1053 #if DEBUG_TCP_NAT
1054       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1055                        _("Found valid IPv4 NAT address (creating session)!\n"));
1056 #endif
1057       session = create_session (plugin, target, NULL, GNUNET_YES);
1058       GNUNET_assert (session != NULL);
1059
1060       /* create new message entry */
1061       pm = GNUNET_malloc (sizeof (struct PendingMessage) + msgbuf_size);
1062       /* FIXME: the memset of this malloc can be up to 2% of our total runtime */
1063       pm->msg = (const char *) &pm[1];
1064       memcpy (&pm[1], msg, msgbuf_size);
1065       /* FIXME: this memcpy can be up to 7% of our total run-time
1066        * (for transport service) */
1067       pm->message_size = msgbuf_size;
1068       pm->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1069       pm->transmit_cont = cont;
1070       pm->transmit_cont_cls = cont_cls;
1071
1072       /* append pm to pending_messages list */
1073       GNUNET_CONTAINER_DLL_insert_tail (session->pending_messages_head,
1074                                          session->pending_messages_tail, pm);
1075
1076       GNUNET_assert (GNUNET_CONTAINER_multihashmap_put
1077                      (plugin->nat_wait_conns, &target->hashPubKey, session,
1078                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY) ==
1079                      GNUNET_OK);
1080 #if DEBUG_TCP_NAT
1081       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1082                        "Created NAT WAIT connection to `%4s' at `%s'\n",
1083                        GNUNET_i2s (target), GNUNET_a2s (sb, sbs));
1084 #endif
1085       GNUNET_NAT_run_client (plugin->nat, &a4);
1086       return 0;
1087     }
1088     if ((is_natd == GNUNET_YES) &&
1089         (GNUNET_YES ==
1090          GNUNET_CONTAINER_multihashmap_contains (plugin->nat_wait_conns,
1091                                                  &target->hashPubKey)))
1092     {
1093       /* Only do one NAT punch attempt per peer identity */
1094       return -1;
1095     }
1096     sa = GNUNET_CONNECTION_create_from_sockaddr (af, sb, sbs);
1097     if (sa == NULL)
1098     {
1099 #if DEBUG_TCP
1100       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1101                        "Failed to create connection to `%4s' at `%s'\n",
1102                        GNUNET_i2s (target), GNUNET_a2s (sb, sbs));
1103 #endif
1104       GNUNET_STATISTICS_update (plugin->env->stats,
1105                                 gettext_noop
1106                                 ("# bytes discarded by TCP (failed to connect)"),
1107                                 msgbuf_size, GNUNET_NO);
1108       return -1;
1109     }
1110     GNUNET_assert (0 != plugin->max_connections);
1111     plugin->max_connections--;
1112 #if DEBUG_TCP_NAT
1113     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1114                      "Asked to transmit to `%4s', creating fresh session using address `%s'.\n",
1115                      GNUNET_i2s (target), GNUNET_a2s (sb, sbs));
1116 #endif
1117     session =
1118         create_session (plugin, target,
1119                         GNUNET_SERVER_connect_socket (plugin->server, sa),
1120                         GNUNET_NO);
1121     session->connect_addr = GNUNET_malloc (addrlen);
1122     memcpy (session->connect_addr, addr, addrlen);
1123     session->connect_alen = addrlen;
1124   }
1125   else                          /* session != NULL */
1126   {
1127     /* check if session is valid */
1128     struct Session *ses = plugin->sessions;
1129
1130     while ((ses != NULL) && (ses != session))
1131       ses = ses->next;
1132     if (ses == NULL)
1133     {
1134       GNUNET_break (0);
1135       return -1;
1136     }
1137   }
1138   GNUNET_assert (session != NULL);
1139   GNUNET_assert (session->client != NULL);
1140
1141
1142   GNUNET_SERVER_client_set_timeout (session->client,
1143                                     GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1144   GNUNET_STATISTICS_update (plugin->env->stats,
1145                             gettext_noop ("# bytes currently in TCP buffers"),
1146                             msgbuf_size, GNUNET_NO);
1147   /* create new message entry */
1148   pm = GNUNET_malloc (sizeof (struct PendingMessage) + msgbuf_size);
1149   pm->msg = (const char *) &pm[1];
1150   memcpy (&pm[1], msg, msgbuf_size);
1151   pm->message_size = msgbuf_size;
1152   pm->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1153   pm->transmit_cont = cont;
1154   pm->transmit_cont_cls = cont_cls;
1155
1156   /* append pm to pending_messages list */
1157   GNUNET_CONTAINER_DLL_insert_tail (session->pending_messages_head,
1158                                     session->pending_messages_tail, pm);
1159 #if DEBUG_TCP
1160   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1161                    "Asked to transmit %u bytes to `%s', added message to list.\n",
1162                    msgbuf_size, GNUNET_i2s (target));
1163 #endif
1164   process_pending_messages (session);
1165   return msgbuf_size;
1166 }
1167
1168
1169 /**
1170  * Function that can be called to force a disconnect from the
1171  * specified neighbour.  This should also cancel all previously
1172  * scheduled transmissions.  Obviously the transmission may have been
1173  * partially completed already, which is OK.  The plugin is supposed
1174  * to close the connection (if applicable) and no longer call the
1175  * transmit continuation(s).
1176  *
1177  * Finally, plugin MUST NOT call the services's receive function to
1178  * notify the service that the connection to the specified target was
1179  * closed after a getting this call.
1180  *
1181  * @param cls closure
1182  * @param target peer for which the last transmission is
1183  *        to be cancelled
1184  */
1185 static void
1186 tcp_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
1187 {
1188   struct Plugin *plugin = cls;
1189   struct Session *session;
1190   struct Session *next;
1191   struct PendingMessage *pm;
1192
1193 #if DEBUG_TCP
1194   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1195                    "Asked to cancel session with `%4s'\n", GNUNET_i2s (target));
1196 #endif
1197   next = plugin->sessions;
1198   while (NULL != (session = next))
1199   {
1200     next = session->next;
1201     if (0 !=
1202         memcmp (target, &session->target, sizeof (struct GNUNET_PeerIdentity)))
1203       continue;
1204     pm = session->pending_messages_head;
1205     while (pm != NULL)
1206     {
1207       pm->transmit_cont = NULL;
1208       pm->transmit_cont_cls = NULL;
1209       pm = pm->next;
1210     }
1211     GNUNET_STATISTICS_update (session->plugin->env->stats,
1212                               gettext_noop
1213                               ("# transport-service disconnect requests for TCP"),
1214                               1, GNUNET_NO);
1215     disconnect_session (session);
1216   }
1217 }
1218
1219
1220 /**
1221  * Context for address to string conversion.
1222  */
1223 struct PrettyPrinterContext
1224 {
1225   /**
1226    * Function to call with the result.
1227    */
1228   GNUNET_TRANSPORT_AddressStringCallback asc;
1229
1230   /**
1231    * Clsoure for 'asc'.
1232    */
1233   void *asc_cls;
1234
1235   /**
1236    * Port to add after the IP address.
1237    */
1238   uint16_t port;
1239 };
1240
1241
1242 /**
1243  * Append our port and forward the result.
1244  *
1245  * @param cls the 'struct PrettyPrinterContext*'
1246  * @param hostname hostname part of the address
1247  */
1248 static void
1249 append_port (void *cls, const char *hostname)
1250 {
1251   struct PrettyPrinterContext *ppc = cls;
1252   char *ret;
1253
1254   if (hostname == NULL)
1255   {
1256     ppc->asc (ppc->asc_cls, NULL);
1257     GNUNET_free (ppc);
1258     return;
1259   }
1260   GNUNET_asprintf (&ret, "%s:%d", hostname, ppc->port);
1261   ppc->asc (ppc->asc_cls, ret);
1262   GNUNET_free (ret);
1263 }
1264
1265
1266 /**
1267  * Convert the transports address to a nice, human-readable
1268  * format.
1269  *
1270  * @param cls closure
1271  * @param type name of the transport that generated the address
1272  * @param addr one of the addresses of the host, NULL for the last address
1273  *        the specific address format depends on the transport
1274  * @param addrlen length of the address
1275  * @param numeric should (IP) addresses be displayed in numeric form?
1276  * @param timeout after how long should we give up?
1277  * @param asc function to call on each string
1278  * @param asc_cls closure for asc
1279  */
1280 static void
1281 tcp_plugin_address_pretty_printer (void *cls, const char *type,
1282                                    const void *addr, size_t addrlen,
1283                                    int numeric,
1284                                    struct GNUNET_TIME_Relative timeout,
1285                                    GNUNET_TRANSPORT_AddressStringCallback asc,
1286                                    void *asc_cls)
1287 {
1288   struct PrettyPrinterContext *ppc;
1289   const void *sb;
1290   size_t sbs;
1291   struct sockaddr_in a4;
1292   struct sockaddr_in6 a6;
1293   const struct IPv4TcpAddress *t4;
1294   const struct IPv6TcpAddress *t6;
1295   uint16_t port;
1296
1297   if (addrlen == sizeof (struct IPv6TcpAddress))
1298   {
1299     t6 = addr;
1300     memset (&a6, 0, sizeof (a6));
1301     a6.sin6_family = AF_INET6;
1302     a6.sin6_port = t6->t6_port;
1303     memcpy (&a6.sin6_addr, &t6->ipv6_addr, sizeof (struct in6_addr));
1304     port = ntohs (t6->t6_port);
1305     sb = &a6;
1306     sbs = sizeof (a6);
1307   }
1308   else if (addrlen == sizeof (struct IPv4TcpAddress))
1309   {
1310     t4 = addr;
1311     memset (&a4, 0, sizeof (a4));
1312     a4.sin_family = AF_INET;
1313     a4.sin_port = t4->t4_port;
1314     a4.sin_addr.s_addr = t4->ipv4_addr;
1315     port = ntohs (t4->t4_port);
1316     sb = &a4;
1317     sbs = sizeof (a4);
1318   }
1319   else
1320   {
1321     /* invalid address */
1322     GNUNET_break_op (0);
1323     asc (asc_cls, NULL);
1324     return;
1325   }
1326   ppc = GNUNET_malloc (sizeof (struct PrettyPrinterContext));
1327   ppc->asc = asc;
1328   ppc->asc_cls = asc_cls;
1329   ppc->port = port;
1330   GNUNET_RESOLVER_hostname_get (sb, sbs, !numeric, timeout, &append_port, ppc);
1331 }
1332
1333
1334 /**
1335  * Check if the given port is plausible (must be either our listen
1336  * port or our advertised port), or any port if we are behind NAT
1337  * and do not have a port open.  If it is neither, we return
1338  * GNUNET_SYSERR.
1339  *
1340  * @param plugin global variables
1341  * @param in_port port number to check
1342  * @return GNUNET_OK if port is either open_port or adv_port
1343  */
1344 static int
1345 check_port (struct Plugin *plugin, uint16_t in_port)
1346 {
1347   if ((in_port == plugin->adv_port) || (in_port == plugin->open_port))
1348     return GNUNET_OK;
1349   return GNUNET_SYSERR;
1350 }
1351
1352
1353 /**
1354  * Function that will be called to check if a binary address for this
1355  * plugin is well-formed and corresponds to an address for THIS peer
1356  * (as per our configuration).  Naturally, if absolutely necessary,
1357  * plugins can be a bit conservative in their answer, but in general
1358  * plugins should make sure that the address does not redirect
1359  * traffic to a 3rd party that might try to man-in-the-middle our
1360  * traffic.
1361  *
1362  * @param cls closure, our 'struct Plugin*'
1363  * @param addr pointer to the address
1364  * @param addrlen length of addr
1365  * @return GNUNET_OK if this is a plausible address for this peer
1366  *         and transport, GNUNET_SYSERR if not
1367  */
1368 static int
1369 tcp_plugin_check_address (void *cls, const void *addr, size_t addrlen)
1370 {
1371   struct Plugin *plugin = cls;
1372   struct IPv4TcpAddress *v4;
1373   struct IPv6TcpAddress *v6;
1374
1375   if ((addrlen != sizeof (struct IPv4TcpAddress)) &&
1376       (addrlen != sizeof (struct IPv6TcpAddress)))
1377   {
1378     GNUNET_break_op (0);
1379     return GNUNET_SYSERR;
1380   }
1381   if (addrlen == sizeof (struct IPv4TcpAddress))
1382   {
1383     v4 = (struct IPv4TcpAddress *) addr;
1384     if (GNUNET_OK != check_port (plugin, ntohs (v4->t4_port)))
1385       return GNUNET_SYSERR;
1386     if (GNUNET_OK !=
1387         GNUNET_NAT_test_address (plugin->nat, &v4->ipv4_addr,
1388                                  sizeof (struct in_addr)))
1389       return GNUNET_SYSERR;
1390   }
1391   else
1392   {
1393     v6 = (struct IPv6TcpAddress *) addr;
1394     if (IN6_IS_ADDR_LINKLOCAL (&v6->ipv6_addr))
1395     {
1396       GNUNET_break_op (0);
1397       return GNUNET_SYSERR;
1398     }
1399     if (GNUNET_OK != check_port (plugin, ntohs (v6->t6_port)))
1400       return GNUNET_SYSERR;
1401     if (GNUNET_OK !=
1402         GNUNET_NAT_test_address (plugin->nat, &v6->ipv6_addr,
1403                                  sizeof (struct in6_addr)))
1404       return GNUNET_SYSERR;
1405   }
1406   return GNUNET_OK;
1407 }
1408
1409
1410 /**
1411  * We've received a nat probe from this peer via TCP.  Finish
1412  * creating the client session and resume sending of queued
1413  * messages.
1414  *
1415  * @param cls closure
1416  * @param client identification of the client
1417  * @param message the actual message
1418  */
1419 static void
1420 handle_tcp_nat_probe (void *cls, struct GNUNET_SERVER_Client *client,
1421                       const struct GNUNET_MessageHeader *message)
1422 {
1423   struct Plugin *plugin = cls;
1424   struct Session *session;
1425   const struct TCP_NAT_ProbeMessage *tcp_nat_probe;
1426   size_t alen;
1427   void *vaddr;
1428   struct IPv4TcpAddress *t4;
1429   struct IPv6TcpAddress *t6;
1430   const struct sockaddr_in *s4;
1431   const struct sockaddr_in6 *s6;
1432
1433 #if DEBUG_TCP_NAT
1434   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp", "received NAT probe\n");
1435 #endif
1436   /* We have received a TCP NAT probe, meaning we (hopefully) initiated
1437    * a connection to this peer by running gnunet-nat-client.  This peer
1438    * received the punch message and now wants us to use the new connection
1439    * as the default for that peer.  Do so and then send a WELCOME message
1440    * so we can really be connected!
1441    */
1442   if (ntohs (message->size) != sizeof (struct TCP_NAT_ProbeMessage))
1443   {
1444     GNUNET_break_op (0);
1445     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1446     return;
1447   }
1448
1449   tcp_nat_probe = (const struct TCP_NAT_ProbeMessage *) message;
1450   if (0 ==
1451       memcmp (&tcp_nat_probe->clientIdentity, plugin->env->my_identity,
1452               sizeof (struct GNUNET_PeerIdentity)))
1453   {
1454     /* refuse connections from ourselves */
1455     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1456     return;
1457   }
1458
1459   session =
1460       GNUNET_CONTAINER_multihashmap_get (plugin->nat_wait_conns,
1461                                          &tcp_nat_probe->
1462                                          clientIdentity.hashPubKey);
1463   if (session == NULL)
1464   {
1465 #if DEBUG_TCP_NAT
1466     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1467                      "Did NOT find session for NAT probe!\n");
1468 #endif
1469     GNUNET_SERVER_receive_done (client, GNUNET_OK);
1470     return;
1471   }
1472 #if DEBUG_TCP_NAT
1473   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1474                    "Found session for NAT probe!\n");
1475 #endif
1476   GNUNET_assert (GNUNET_CONTAINER_multihashmap_remove
1477                  (plugin->nat_wait_conns,
1478                   &tcp_nat_probe->clientIdentity.hashPubKey,
1479                   session) == GNUNET_YES);
1480   if (GNUNET_OK != GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
1481   {
1482     GNUNET_break (0);
1483     GNUNET_free (session);
1484     GNUNET_SERVER_receive_done (client, GNUNET_OK);
1485     return;
1486   }
1487
1488   GNUNET_SERVER_client_keep (client);
1489   session->client = client;
1490   session->last_activity = GNUNET_TIME_absolute_get ();
1491   session->inbound = GNUNET_NO;
1492
1493 #if DEBUG_TCP_NAT
1494   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1495                    "Found address `%s' for incoming connection\n",
1496                    GNUNET_a2s (vaddr, alen));
1497 #endif
1498   switch (((const struct sockaddr *) vaddr)->sa_family)
1499   {
1500   case AF_INET:
1501     s4 = vaddr;
1502     t4 = GNUNET_malloc (sizeof (struct IPv4TcpAddress));
1503     t4->t4_port = s4->sin_port;
1504     t4->ipv4_addr = s4->sin_addr.s_addr;
1505     session->connect_addr = t4;
1506     session->connect_alen = sizeof (struct IPv4TcpAddress);
1507     break;
1508   case AF_INET6:
1509     s6 = vaddr;
1510     t6 = GNUNET_malloc (sizeof (struct IPv6TcpAddress));
1511     t6->t6_port = s6->sin6_port;
1512     memcpy (&t6->ipv6_addr, &s6->sin6_addr, sizeof (struct in6_addr));
1513     session->connect_addr = t6;
1514     session->connect_alen = sizeof (struct IPv6TcpAddress);
1515     break;
1516   default:
1517     GNUNET_break_op (0);
1518 #if DEBUG_TCP_NAT
1519     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1520                      "Bad address for incoming connection!\n");
1521 #endif
1522     GNUNET_free (vaddr);
1523     GNUNET_SERVER_client_drop (client);
1524     GNUNET_free (session);
1525     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1526     return;
1527   }
1528   GNUNET_free (vaddr);
1529
1530   session->next = plugin->sessions;
1531   plugin->sessions = session;
1532   GNUNET_STATISTICS_update (plugin->env->stats,
1533                             gettext_noop ("# TCP sessions active"), 1,
1534                             GNUNET_NO);
1535   process_pending_messages (session);
1536   GNUNET_SERVER_receive_done (client, GNUNET_OK);
1537 }
1538
1539
1540 /**
1541  * We've received a welcome from this peer via TCP.  Possibly create a
1542  * fresh client record and send back our welcome.
1543  *
1544  * @param cls closure
1545  * @param client identification of the client
1546  * @param message the actual message
1547  */
1548 static void
1549 handle_tcp_welcome (void *cls, struct GNUNET_SERVER_Client *client,
1550                     const struct GNUNET_MessageHeader *message)
1551 {
1552   struct Plugin *plugin = cls;
1553   const struct WelcomeMessage *wm = (const struct WelcomeMessage *) message;
1554   struct Session *session;
1555   size_t alen;
1556   void *vaddr;
1557   struct IPv4TcpAddress *t4;
1558   struct IPv6TcpAddress *t6;
1559   const struct sockaddr_in *s4;
1560   const struct sockaddr_in6 *s6;
1561
1562   if (0 ==
1563       memcmp (&wm->clientIdentity, plugin->env->my_identity,
1564               sizeof (struct GNUNET_PeerIdentity)))
1565   {
1566     /* refuse connections from ourselves */
1567     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1568     return;
1569   }
1570 #if DEBUG_TCP
1571   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1572                    "Received %s message from `%4s'.\n", "WELCOME",
1573                    GNUNET_i2s (&wm->clientIdentity));
1574 #endif
1575   GNUNET_STATISTICS_update (plugin->env->stats,
1576                             gettext_noop ("# TCP WELCOME messages received"), 1,
1577                             GNUNET_NO);
1578   session = find_session_by_client (plugin, client);
1579
1580   if (session == NULL)
1581   {
1582 #if DEBUG_TCP_NAT
1583     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1584                      "Received %s message from a `%4s', creating new session\n",
1585                      "WELCOME", GNUNET_i2s (&wm->clientIdentity));
1586 #endif
1587     GNUNET_SERVER_client_keep (client);
1588     session = create_session (plugin, &wm->clientIdentity, client, GNUNET_NO);
1589     session->inbound = GNUNET_YES;
1590     if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
1591     {
1592 #if DEBUG_TCP_NAT
1593       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1594                        "Found address `%s' for incoming connection\n",
1595                        GNUNET_a2s (vaddr, alen));
1596 #endif
1597       if (alen == sizeof (struct sockaddr_in))
1598       {
1599         s4 = vaddr;
1600         t4 = GNUNET_malloc (sizeof (struct IPv4TcpAddress));
1601         t4->t4_port = s4->sin_port;
1602         t4->ipv4_addr = s4->sin_addr.s_addr;
1603         session->connect_addr = t4;
1604         session->connect_alen = sizeof (struct IPv4TcpAddress);
1605       }
1606       else if (alen == sizeof (struct sockaddr_in6))
1607       {
1608         s6 = vaddr;
1609         t6 = GNUNET_malloc (sizeof (struct IPv6TcpAddress));
1610         t6->t6_port = s6->sin6_port;
1611         memcpy (&t6->ipv6_addr, &s6->sin6_addr, sizeof (struct in6_addr));
1612         session->connect_addr = t6;
1613         session->connect_alen = sizeof (struct IPv6TcpAddress);
1614       }
1615
1616       GNUNET_free (vaddr);
1617     }
1618     else
1619     {
1620 #if DEBUG_TCP
1621       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1622                        "Did not obtain TCP socket address for incoming connection\n");
1623 #endif
1624     }
1625     process_pending_messages (session);
1626   }
1627   else
1628   {
1629 #if DEBUG_TCP_NAT
1630     if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
1631     {
1632       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1633                        "Found address `%s' (already have session)\n",
1634                        GNUNET_a2s (vaddr, alen));
1635       GNUNET_free (vaddr);
1636     }
1637 #endif
1638   }
1639
1640   if (session->expecting_welcome != GNUNET_YES)
1641   {
1642     GNUNET_break_op (0);
1643     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1644     return;
1645   }
1646   session->last_activity = GNUNET_TIME_absolute_get ();
1647   session->expecting_welcome = GNUNET_NO;
1648   GNUNET_SERVER_client_set_timeout (client,
1649                                     GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1650   GNUNET_SERVER_receive_done (client, GNUNET_OK);
1651 }
1652
1653
1654 /**
1655  * Task to signal the server that we can continue
1656  * receiving from the TCP client now.
1657  *
1658  * @param cls the 'struct Session*'
1659  * @param tc task context (unused)
1660  */
1661 static void
1662 delayed_done (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1663 {
1664   struct Session *session = cls;
1665   struct GNUNET_TIME_Relative delay;
1666   struct GNUNET_ATS_Information ats;
1667
1668   session->receive_delay_task = GNUNET_SCHEDULER_NO_TASK;
1669   delay =
1670       session->plugin->env->receive (session->plugin->env->cls,
1671                                      &session->target, NULL, &ats, 0, session,
1672                                      NULL, 0);
1673   if (delay.rel_value == 0)
1674     GNUNET_SERVER_receive_done (session->client, GNUNET_OK);
1675   else
1676     session->receive_delay_task =
1677         GNUNET_SCHEDULER_add_delayed (delay, &delayed_done, session);
1678 }
1679
1680
1681 /**
1682  * We've received data for this peer via TCP.  Unbox,
1683  * compute latency and forward.
1684  *
1685  * @param cls closure
1686  * @param client identification of the client
1687  * @param message the actual message
1688  */
1689 static void
1690 handle_tcp_data (void *cls, struct GNUNET_SERVER_Client *client,
1691                  const struct GNUNET_MessageHeader *message)
1692 {
1693   struct Plugin *plugin = cls;
1694   struct Session *session;
1695   struct GNUNET_TIME_Relative delay;
1696   uint16_t type;
1697
1698   type = ntohs (message->type);
1699   if ((GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME == type) ||
1700       (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE == type))
1701   {
1702     /* We don't want to propagate WELCOME and NAT Probe messages up! */
1703     GNUNET_SERVER_receive_done (client, GNUNET_OK);
1704     return;
1705   }
1706   session = find_session_by_client (plugin, client);
1707   if ((NULL == session) || (GNUNET_YES == session->expecting_welcome))
1708   {
1709     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1710     return;
1711   }
1712   session->last_activity = GNUNET_TIME_absolute_get ();
1713 #if DEBUG_TCP
1714   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1715                    "Passing %u bytes of type %u from `%4s' to transport service.\n",
1716                    (unsigned int) ntohs (message->size),
1717                    (unsigned int) ntohs (message->type),
1718                    GNUNET_i2s (&session->target));
1719 #endif
1720   GNUNET_STATISTICS_update (plugin->env->stats,
1721                             gettext_noop ("# bytes received via TCP"),
1722                             ntohs (message->size), GNUNET_NO);
1723   struct GNUNET_ATS_Information distance;
1724
1725   distance.type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
1726   distance.value = htonl (1);
1727   delay =
1728       plugin->env->receive (plugin->env->cls, &session->target, message,
1729                             (const struct GNUNET_ATS_Information *)
1730                             &distance, 1, session,
1731                             (GNUNET_YES ==
1732                              session->inbound) ? NULL : session->connect_addr,
1733                             (GNUNET_YES ==
1734                              session->inbound) ? 0 : session->connect_alen);
1735   if (delay.rel_value == 0)
1736   {
1737     GNUNET_SERVER_receive_done (client, GNUNET_OK);
1738   }
1739   else
1740   {
1741 #if DEBUG_TCP
1742     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1743                      "Throttling receiving from `%s' for %llu ms\n",
1744                      GNUNET_i2s (&session->target),
1745                      (unsigned long long) delay.rel_value);
1746 #endif
1747     GNUNET_SERVER_disable_receive_done_warning (client);
1748     session->receive_delay_task =
1749         GNUNET_SCHEDULER_add_delayed (delay, &delayed_done, session);
1750   }
1751 }
1752
1753
1754 /**
1755  * Functions with this signature are called whenever a peer
1756  * is disconnected on the network level.
1757  *
1758  * @param cls closure
1759  * @param client identification of the client
1760  */
1761 static void
1762 disconnect_notify (void *cls, struct GNUNET_SERVER_Client *client)
1763 {
1764   struct Plugin *plugin = cls;
1765   struct Session *session;
1766
1767   if (client == NULL)
1768     return;
1769   plugin->max_connections++;
1770   session = find_session_by_client (plugin, client);
1771   if (session == NULL)
1772     return;                     /* unknown, nothing to do */
1773 #if DEBUG_TCP
1774   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1775                    "Destroying session of `%4s' with %s due to network-level disconnect.\n",
1776                    GNUNET_i2s (&session->target),
1777                    (session->connect_addr !=
1778                     NULL) ? tcp_address_to_string (session->plugin,
1779                                                    session->connect_addr,
1780                                                    session->connect_alen) :
1781                    "*");
1782 #endif
1783   GNUNET_STATISTICS_update (session->plugin->env->stats,
1784                             gettext_noop
1785                             ("# network-level TCP disconnect events"), 1,
1786                             GNUNET_NO);
1787   disconnect_session (session);
1788 }
1789
1790
1791 /**
1792  * We can now send a probe message, copy into buffer to really send.
1793  *
1794  * @param cls closure, a struct TCPProbeContext
1795  * @param size max size to copy
1796  * @param buf buffer to copy message to
1797  * @return number of bytes copied into buf
1798  */
1799 static size_t
1800 notify_send_probe (void *cls, size_t size, void *buf)
1801 {
1802   struct TCPProbeContext *tcp_probe_ctx = cls;
1803   struct Plugin *plugin = tcp_probe_ctx->plugin;
1804   size_t ret;
1805
1806   tcp_probe_ctx->transmit_handle = NULL;
1807   GNUNET_CONTAINER_DLL_remove (plugin->probe_head, plugin->probe_tail,
1808                                tcp_probe_ctx);
1809   if (buf == NULL)
1810   {
1811     GNUNET_CONNECTION_destroy (tcp_probe_ctx->sock, GNUNET_NO);
1812     GNUNET_free (tcp_probe_ctx);
1813     return 0;
1814   }
1815   GNUNET_assert (size >= sizeof (tcp_probe_ctx->message));
1816   memcpy (buf, &tcp_probe_ctx->message, sizeof (tcp_probe_ctx->message));
1817   GNUNET_SERVER_connect_socket (tcp_probe_ctx->plugin->server,
1818                                 tcp_probe_ctx->sock);
1819   ret = sizeof (tcp_probe_ctx->message);
1820   GNUNET_free (tcp_probe_ctx);
1821   return ret;
1822 }
1823
1824
1825 /**
1826  * Function called by the NAT subsystem suggesting another peer wants
1827  * to connect to us via connection reversal.  Try to connect back to the
1828  * given IP.
1829  *
1830  * @param cls closure
1831  * @param addr address to try
1832  * @param addrlen number of bytes in addr
1833  */
1834 static void
1835 try_connection_reversal (void *cls, const struct sockaddr *addr,
1836                          socklen_t addrlen)
1837 {
1838   struct Plugin *plugin = cls;
1839   struct GNUNET_CONNECTION_Handle *sock;
1840   struct TCPProbeContext *tcp_probe_ctx;
1841
1842   /**
1843    * We have received an ICMP response, ostensibly from a peer
1844    * that wants to connect to us! Send a message to establish a connection.
1845    */
1846   sock = GNUNET_CONNECTION_create_from_sockaddr (AF_INET, addr, addrlen);
1847   if (sock == NULL)
1848   {
1849     /* failed for some odd reason (out of sockets?); ignore attempt */
1850     return;
1851   }
1852
1853   /* FIXME: do we need to track these probe context objects so that
1854    * we can clean them up on plugin unload? */
1855   tcp_probe_ctx = GNUNET_malloc (sizeof (struct TCPProbeContext));
1856   tcp_probe_ctx->message.header.size =
1857       htons (sizeof (struct TCP_NAT_ProbeMessage));
1858   tcp_probe_ctx->message.header.type =
1859       htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE);
1860   memcpy (&tcp_probe_ctx->message.clientIdentity, plugin->env->my_identity,
1861           sizeof (struct GNUNET_PeerIdentity));
1862   tcp_probe_ctx->plugin = plugin;
1863   tcp_probe_ctx->sock = sock;
1864   GNUNET_CONTAINER_DLL_insert (plugin->probe_head, plugin->probe_tail,
1865                                tcp_probe_ctx);
1866   tcp_probe_ctx->transmit_handle =
1867       GNUNET_CONNECTION_notify_transmit_ready (sock,
1868                                                ntohs (tcp_probe_ctx->
1869                                                       message.header.size),
1870                                                GNUNET_TIME_UNIT_FOREVER_REL,
1871                                                &notify_send_probe,
1872                                                tcp_probe_ctx);
1873
1874 }
1875
1876
1877 /**
1878  * Entry point for the plugin.
1879  *
1880  * @param cls closure, the 'struct GNUNET_TRANSPORT_PluginEnvironment*'
1881  * @return the 'struct GNUNET_TRANSPORT_PluginFunctions*' or NULL on error
1882  */
1883 void *
1884 libgnunet_plugin_transport_tcp_init (void *cls)
1885 {
1886   static const struct GNUNET_SERVER_MessageHandler my_handlers[] = {
1887     {&handle_tcp_welcome, NULL, GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME,
1888      sizeof (struct WelcomeMessage)},
1889     {&handle_tcp_nat_probe, NULL, GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE,
1890      sizeof (struct TCP_NAT_ProbeMessage)},
1891     {&handle_tcp_data, NULL, GNUNET_MESSAGE_TYPE_ALL, 0},
1892     {NULL, NULL, 0, 0}
1893   };
1894   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1895   struct GNUNET_TRANSPORT_PluginFunctions *api;
1896   struct Plugin *plugin;
1897   struct GNUNET_SERVICE_Context *service;
1898   unsigned long long aport;
1899   unsigned long long bport;
1900   unsigned long long max_connections;
1901   unsigned int i;
1902   struct GNUNET_TIME_Relative idle_timeout;
1903   int ret;
1904   struct sockaddr **addrs;
1905   socklen_t *addrlens;
1906
1907   if (GNUNET_OK !=
1908       GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp",
1909                                              "MAX_CONNECTIONS",
1910                                              &max_connections))
1911     max_connections = 128;
1912
1913   aport = 0;
1914   if ((GNUNET_OK !=
1915        GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp", "PORT",
1916                                               &bport)) || (bport > 65535) ||
1917       ((GNUNET_OK ==
1918         GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp",
1919                                                "ADVERTISED-PORT", &aport)) &&
1920        (aport > 65535)))
1921   {
1922     GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "tcp",
1923                      _
1924                      ("Require valid port number for service `%s' in configuration!\n"),
1925                      "transport-tcp");
1926     return NULL;
1927   }
1928   if (aport == 0)
1929     aport = bport;
1930   if (bport == 0)
1931     aport = 0;
1932   if (bport != 0)
1933   {
1934     service = GNUNET_SERVICE_start ("transport-tcp", env->cfg);
1935     if (service == NULL)
1936     {
1937       GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING, "tcp",
1938                        _("Failed to start service.\n"));
1939       return NULL;
1940     }
1941   }
1942   else
1943     service = NULL;
1944
1945
1946
1947   plugin = GNUNET_malloc (sizeof (struct Plugin));
1948   plugin->max_connections = max_connections;
1949   plugin->open_port = bport;
1950   plugin->adv_port = aport;
1951   plugin->env = env;
1952   plugin->lsock = NULL;
1953   if ((service != NULL) &&
1954       (GNUNET_SYSERR !=
1955        (ret =
1956         GNUNET_SERVICE_get_server_addresses ("transport-tcp", env->cfg, &addrs,
1957                                              &addrlens))))
1958   {
1959     plugin->nat =
1960         GNUNET_NAT_register (env->cfg, GNUNET_YES, aport, (unsigned int) ret,
1961                              (const struct sockaddr **) addrs, addrlens,
1962                              &tcp_nat_port_map_callback,
1963                              &try_connection_reversal, plugin);
1964     while (ret > 0)
1965     {
1966       ret--;
1967       GNUNET_assert (addrs[ret] != NULL);
1968       GNUNET_free (addrs[ret]);
1969     }
1970     GNUNET_free_non_null (addrs);
1971     GNUNET_free_non_null (addrlens);
1972   }
1973   else
1974   {
1975     plugin->nat =
1976         GNUNET_NAT_register (env->cfg, GNUNET_YES, 0, 0, NULL, NULL, NULL,
1977                              &try_connection_reversal, plugin);
1978   }
1979   api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1980   api->cls = plugin;
1981   api->send = &tcp_plugin_send;
1982   api->disconnect = &tcp_plugin_disconnect;
1983   api->address_pretty_printer = &tcp_plugin_address_pretty_printer;
1984   api->check_address = &tcp_plugin_check_address;
1985   api->address_to_string = &tcp_address_to_string;
1986   plugin->service = service;
1987   if (service != NULL)
1988   {
1989     plugin->server = GNUNET_SERVICE_get_server (service);
1990   }
1991   else
1992   {
1993     if (GNUNET_OK !=
1994         GNUNET_CONFIGURATION_get_value_time (env->cfg, "transport-tcp",
1995                                              "TIMEOUT", &idle_timeout))
1996     {
1997       GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "tcp",
1998                        _("Failed to find option %s in section %s!\n"),
1999                        "TIMEOUT", "transport-tcp");
2000       if (plugin->nat != NULL)
2001         GNUNET_NAT_unregister (plugin->nat);
2002       GNUNET_free (plugin);
2003       GNUNET_free (api);
2004       return NULL;
2005     }
2006     plugin->server =
2007         GNUNET_SERVER_create_with_sockets (&plugin_tcp_access_check, plugin,
2008                                            NULL, idle_timeout, GNUNET_YES);
2009   }
2010   plugin->handlers = GNUNET_malloc (sizeof (my_handlers));
2011   memcpy (plugin->handlers, my_handlers, sizeof (my_handlers));
2012   for (i = 0;
2013        i < sizeof (my_handlers) / sizeof (struct GNUNET_SERVER_MessageHandler);
2014        i++)
2015     plugin->handlers[i].callback_cls = plugin;
2016   GNUNET_SERVER_add_handlers (plugin->server, plugin->handlers);
2017   GNUNET_SERVER_disconnect_notify (plugin->server, &disconnect_notify, plugin);
2018   plugin->nat_wait_conns = GNUNET_CONTAINER_multihashmap_create (16);
2019   if (bport != 0)
2020     GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "tcp",
2021                      _("TCP transport listening on port %llu\n"), bport);
2022   else
2023     GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "tcp",
2024                      _
2025                      ("TCP transport not listening on any port (client only)\n"));
2026   if (aport != bport)
2027     GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "tcp",
2028                      _
2029                      ("TCP transport advertises itself as being on port %llu\n"),
2030                      aport);
2031   return api;
2032 }
2033
2034
2035 /**
2036  * Exit point from the plugin.
2037  */
2038 void *
2039 libgnunet_plugin_transport_tcp_done (void *cls)
2040 {
2041   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
2042   struct Plugin *plugin = api->cls;
2043   struct Session *session;
2044   struct TCPProbeContext *tcp_probe;
2045
2046   while (NULL != (session = plugin->sessions))
2047     disconnect_session (session);
2048   if (plugin->service != NULL)
2049     GNUNET_SERVICE_stop (plugin->service);
2050   else
2051     GNUNET_SERVER_destroy (plugin->server);
2052   GNUNET_free (plugin->handlers);
2053   if (plugin->nat != NULL)
2054     GNUNET_NAT_unregister (plugin->nat);
2055   while (NULL != (tcp_probe = plugin->probe_head))
2056   {
2057     GNUNET_CONTAINER_DLL_remove (plugin->probe_head, plugin->probe_tail,
2058                                  tcp_probe);
2059     GNUNET_CONNECTION_destroy (tcp_probe->sock, GNUNET_NO);
2060     GNUNET_free (tcp_probe);
2061   }
2062   GNUNET_CONTAINER_multihashmap_destroy (plugin->nat_wait_conns);
2063   GNUNET_free (plugin);
2064   GNUNET_free (api);
2065   return NULL;
2066 }
2067
2068 /* end of plugin_transport_tcp.c */