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 2, 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 /**
  22  * @file transport/plugin_transport_tcp.c
  23  * @brief Implementation of the TCP transport service
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_hello_lib.h"
  29 #include "gnunet_connection_lib.h"
  30 #include "gnunet_container_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 "plugin_transport.h"
  40 #include "transport.h"
  41
  42 #define DEBUG_TCP GNUNET_YES
  43
  44 /**
  45  * How long until we give up on transmitting the welcome message?
  46  */
  47 #define HOSTNAME_RESOLVE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
  48
  49
  50 /**
  51  * Initial handshake message for a session.
  52  */
  53 struct WelcomeMessage
  54 {
  55   /**
  56    * Type is GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME.
  57    */
  58   struct GNUNET_MessageHeader header;
  59
  60   /**
  61    * Identity of the node connecting (TCP client)
  62    */
  63   struct GNUNET_PeerIdentity clientIdentity;
  64
  65 };
  66
  67
  68 /**
  69  * Encapsulation of all of the state of the plugin.
  70  */
  71 struct Plugin;
  72
  73
  74 /**
  75  * Information kept for each message that is yet to
  76  * be transmitted.
  77  */
  78 struct PendingMessage
  79 {
  80
  81   /**
  82    * This is a doubly-linked list.
  83    */
  84   struct PendingMessage *next;
  85
  86   /**
  87    * This is a doubly-linked list.
  88    */
  89   struct PendingMessage *prev;
  90
  91   /**
  92    * The pending message
  93    */
  94   const char *msg;
  95
  96   /**
  97    * Continuation function to call once the message
  98    * has been sent.  Can be NULL if there is no
  99    * continuation to call.
 100    */
 101   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
 102
 103   /**
 104    * Closure for transmit_cont.
 105    */
 106   void *transmit_cont_cls;
 107
 108   /**
 109    * Timeout value for the pending message.
 110    */
 111   struct GNUNET_TIME_Absolute timeout;
 112
 113   /**
 114    * So that the gnunet-service-transport can group messages together,
 115    * these pending messages need to accept a message buffer and size
 116    * instead of just a GNUNET_MessageHeader.
 117    */
 118   size_t message_size;
 119
 120 };
 121
 122
 123 /**
 124  * Session handle for TCP connections.
 125  */
 126 struct Session
 127 {
 128
 129   /**
 130    * Stored in a linked list.
 131    */
 132   struct Session *next;
 133
 134   /**
 135    * Pointer to the global plugin struct.
 136    */
 137   struct Plugin *plugin;
 138
 139   /**
 140    * The client (used to identify this connection)
 141    */
 142   struct GNUNET_SERVER_Client *client;
 143
 144   /**
 145    * Messages currently pending for transmission
 146    * to this peer, if any.
 147    */
 148   struct PendingMessage *pending_messages_head;
 149
 150   /**
 151    * Messages currently pending for transmission
 152    * to this peer, if any.
 153    */
 154   struct PendingMessage *pending_messages_tail;
 155
 156   /**
 157    * Handle for pending transmission request.
 158    */
 159   struct GNUNET_CONNECTION_TransmitHandle *transmit_handle;
 160
 161   /**
 162    * To whom are we talking to (set to our identity
 163    * if we are still waiting for the welcome message)
 164    */
 165   struct GNUNET_PeerIdentity target;
 166
 167   /**
 168    * At what time did we reset last_received last?
 169    */
 170   struct GNUNET_TIME_Absolute last_quota_update;
 171
 172   /**
 173    * Address of the other peer (either based on our 'connect'
 174    * call or on our 'accept' call).
 175    */
 176   void *connect_addr;
 177
 178   /**
 179    * How many bytes have we received since the "last_quota_update"
 180    * timestamp?
 181    */
 182   uint64_t last_received;
 183
 184   /**
 185    * Number of bytes per ms that this peer is allowed
 186    * to send to us.
 187    */
 188   uint32_t quota_in;
 189
 190   /**
 191    * Length of connect_addr.
 192    */
 193   size_t connect_alen;
 194
 195   /**
 196    * Are we still expecting the welcome message? (GNUNET_YES/GNUNET_NO)
 197    */
 198   int expecting_welcome;
 199
 200 };
 201
 202
 203 /**
 204  * Encapsulation of all of the state of the plugin.
 205  */
 206 struct Plugin
 207 {
 208   /**
 209    * Our environment.
 210    */
 211   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 212
 213   /**
 214    * The listen socket.
 215    */
 216   struct GNUNET_CONNECTION_Handle *lsock;
 217
 218   /**
 219    * List of open TCP sessions.
 220    */
 221   struct Session *sessions;
 222
 223   /**
 224    * Handle for the statistics service.
 225    */
 226   struct GNUNET_STATISTICS_Handle *statistics;
 227
 228   /**
 229    * Handle to the network service.
 230    */
 231   struct GNUNET_SERVICE_Context *service;
 232
 233   /**
 234    * Handle to the server for this service.
 235    */
 236   struct GNUNET_SERVER_Handle *server;
 237
 238   /**
 239    * Copy of the handler array where the closures are
 240    * set to this struct's instance.
 241    */
 242   struct GNUNET_SERVER_MessageHandler *handlers;
 243
 244   /**
 245    * Handle for request of hostname resolution, non-NULL if pending.
 246    */
 247   struct GNUNET_RESOLVER_RequestHandle *hostname_dns;
 248
 249   /**
 250    * ID of task used to update our addresses when one expires.
 251    */
 252   GNUNET_SCHEDULER_TaskIdentifier address_update_task;
 253
 254   /**
 255    * Port that we are actually listening on.
 256    */
 257   uint16_t open_port;
 258
 259   /**
 260    * Port that the user said we would have visible to the
 261    * rest of the world.
 262    */
 263   uint16_t adv_port;
 264
 265 };
 266
 267
 268 /**
 269  * Find a session handle for the given peer.
 270  * FIXME: using a hash map we could do this in O(1).
 271  *
 272  * @return NULL if no matching session exists
 273  */
 274 static struct Session *
 275 find_session_by_target (struct Plugin *plugin,
 276                         const struct GNUNET_PeerIdentity *target)
 277 {
 278   struct Session *ret;
 279
 280   ret = plugin->sessions;
 281   while ( (ret != NULL) &&
 282           ((GNUNET_SYSERR == ret->expecting_welcome) ||
 283            (0 != memcmp (target,
 284                          &ret->target, sizeof (struct GNUNET_PeerIdentity)))))
 285     ret = ret->next;
 286   return ret;
 287 }
 288
 289
 290 /**
 291  * Find the session handle for the given client.
 292  *
 293  * @return NULL if no matching session exists
 294  */
 295 static struct Session *
 296 find_session_by_client (struct Plugin *plugin,
 297                         const struct GNUNET_SERVER_Client *client)
 298 {
 299   struct Session *ret;
 300
 301   ret = plugin->sessions;
 302   while ((ret != NULL) && (client != ret->client))
 303     ret = ret->next;
 304   return ret;
 305 }
 306
 307
 308 /**
 309  * Create a new session.  Also queues a welcome message.
 310  *
 311  * @param plugin us
 312  * @param target peer to connect to
 313  * @param client client to use
 314  * @return new session object
 315  */
 316 static struct Session *
 317 create_session (struct Plugin *plugin,
 318                 const struct GNUNET_PeerIdentity *target,
 319                 struct GNUNET_SERVER_Client *client)
 320 {
 321   struct Session *ret;
 322   struct PendingMessage *pm;
 323   struct WelcomeMessage welcome;
 324
 325   ret = GNUNET_malloc (sizeof (struct Session));
 326   ret->plugin = plugin;
 327   ret->next = plugin->sessions;
 328   plugin->sessions = ret;
 329   ret->client = client;
 330   ret->target = *target;
 331   ret->last_quota_update = GNUNET_TIME_absolute_get ();
 332   ret->quota_in = plugin->env->default_quota_in;
 333   ret->expecting_welcome = GNUNET_YES;
 334   pm = GNUNET_malloc (sizeof (struct PendingMessage) + sizeof (struct WelcomeMessage));
 335   pm->msg = (const char*) &pm[1];
 336   pm->message_size = sizeof (struct WelcomeMessage);
 337   welcome.header.size = htons (sizeof (struct WelcomeMessage));
 338   welcome.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME);
 339   welcome.clientIdentity = *plugin->env->my_identity;
 340   memcpy (&pm[1], &welcome, sizeof (welcome));
 341   pm->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
 342   GNUNET_CONTAINER_DLL_insert (ret->pending_messages_head,
 343                                ret->pending_messages_tail,
 344                                pm);
 345   return ret;
 346 }
 347
 348
 349 /**
 350  * If we have pending messages, ask the server to
 351  * transmit them (schedule the respective tasks, etc.)
 352  *
 353  * @param session for which session should we do this
 354  */
 355 static void process_pending_messages (struct Session *session);
 356
 357
 358 /**
 359  * Function called to notify a client about the socket
 360  * being ready to queue more data.  "buf" will be
 361  * NULL and "size" zero if the socket was closed for
 362  * writing in the meantime.
 363  *
 364  * @param cls closure
 365  * @param size number of bytes available in buf
 366  * @param buf where the callee should write the message
 367  * @return number of bytes written to buf
 368  */
 369 static size_t
 370 do_transmit (void *cls, size_t size, void *buf)
 371 {
 372   struct Session *session = cls;
 373   struct PendingMessage *pm;
 374   char *cbuf;
 375
 376   size_t ret;
 377
 378   session->transmit_handle = NULL;
 379   if (buf == NULL)
 380     {
 381 #if DEBUG_TCP
 382       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 383                        "tcp",
 384                        "Timeout trying to transmit to peer `%4s', discarding message queue.\n",
 385                        GNUNET_i2s (&session->target));
 386 #endif
 387       /* timeout */
 388       while (NULL != (pm = session->pending_messages_head))
 389         {
 390           GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
 391                                        session->pending_messages_tail,
 392                                        pm);
 393 #if DEBUG_TCP
 394           GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 395                            "tcp",
 396                            "Failed to transmit %u byte message to `%4s'.\n",
 397                            pm->message_size,
 398                            GNUNET_i2s (&session->target));
 399 #endif
 400           if (pm->transmit_cont != NULL)
 401             pm->transmit_cont (pm->transmit_cont_cls,
 402                                &session->target, GNUNET_SYSERR);
 403           GNUNET_free (pm);
 404         }
 405       return 0;
 406     }
 407   ret = 0;
 408   cbuf = buf;
 409   while (NULL != (pm = session->pending_messages_head))
 410     {
 411       if (size < pm->message_size)
 412         break;
 413       memcpy (cbuf, pm->msg, pm->message_size);
 414       cbuf += pm->message_size;
 415       ret += pm->message_size;
 416       size -= pm->message_size;
 417       GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
 418                                    session->pending_messages_tail,
 419                                    pm);
 420       if (pm->transmit_cont != NULL)
 421         pm->transmit_cont (pm->transmit_cont_cls,
 422                            &session->target, GNUNET_OK);
 423       GNUNET_free (pm);
 424     }
 425   if (session->client != NULL)
 426     process_pending_messages (session);
 427 #if DEBUG_TCP > 1
 428   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 429                    "tcp", "Transmitting %u bytes\n", ret);
 430 #endif
 431   return ret;
 432 }
 433
 434
 435 /**
 436  * If we have pending messages, ask the server to
 437  * transmit them (schedule the respective tasks, etc.)
 438  *
 439  * @param session for which session should we do this
 440  */
 441 static void
 442 process_pending_messages (struct Session *session)
 443 {
 444   struct PendingMessage *pm;
 445   GNUNET_assert (session->client != NULL);
 446   if (session->transmit_handle != NULL)
 447     return;
 448   if (NULL == (pm = session->pending_messages_head))
 449     return;
 450   session->transmit_handle
 451     = GNUNET_SERVER_notify_transmit_ready (session->client,
 452                                            pm->message_size,
 453                                            GNUNET_TIME_absolute_get_remaining
 454                                            (pm->timeout),
 455                                            &do_transmit, session);
 456 }
 457
 458
 459 /**
 460  * Functions with this signature are called whenever we need
 461  * to close a session due to a disconnect or failure to
 462  * establish a connection.
 463  *
 464  * @param session session to close down
 465  */
 466 static void
 467 disconnect_session (struct Session *session)
 468 {
 469   struct Session *prev;
 470   struct Session *pos;
 471   struct PendingMessage *pm;
 472
 473 #if DEBUG_TCP
 474   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 475                    "tcp",
 476                    "Disconnecting from `%4s' at %s (session %p).\n",
 477                    GNUNET_i2s (&session->target),
 478                    (session->connect_addr != NULL) ?
 479                    GNUNET_a2s (session->connect_addr,
 480                                session->connect_alen) : "*", session);
 481 #endif
 482   /* remove from session list */
 483   prev = NULL;
 484   pos = session->plugin->sessions;
 485   while (pos != session)
 486     {
 487       prev = pos;
 488       pos = pos->next;
 489     }
 490   if (prev == NULL)
 491     session->plugin->sessions = session->next;
 492   else
 493     prev->next = session->next;
 494   /* clean up state */
 495   if (session->transmit_handle != NULL)
 496     {
 497       GNUNET_CONNECTION_notify_transmit_ready_cancel
 498         (session->transmit_handle);
 499       session->transmit_handle = NULL;
 500     }
 501   while (NULL != (pm = session->pending_messages_head))
 502     {
 503 #if DEBUG_TCP
 504       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 505                        "tcp",
 506                        pm->transmit_cont != NULL
 507                        ? "Could not deliver message to `%4s'.\n"
 508                        :
 509                        "Could not deliver message to `%4s', notifying.\n",
 510                        GNUNET_i2s (&session->target));
 511 #endif
 512       GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
 513                                    session->pending_messages_tail,
 514                                    pm);
 515       if (NULL != pm->transmit_cont)
 516         pm->transmit_cont (pm->transmit_cont_cls,
 517                            &session->target, GNUNET_SYSERR);
 518       GNUNET_free (pm);
 519     }
 520   if (GNUNET_NO == session->expecting_welcome)
 521     {
 522 #if DEBUG_TCP
 523       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 524                        "tcp",
 525                        "Notifying transport service about loss of data connection with `%4s'.\n",
 526                        GNUNET_i2s (&session->target));
 527 #endif
 528       /* Data session that actually went past the initial handshake;
 529          transport service may know about this one, so we need to
 530          notify transport service about disconnect */
 531       // FIXME: we should have a very clear connect-disconnect
 532       // protocol with gnunet-service-transport!
 533       session->plugin->env->receive (session->plugin->env->cls,
 534                                      &session->target, NULL,
 535                                      1,
 536                                      session->connect_addr,
 537                                      session->connect_alen);
 538     }
 539   if (session->client != NULL)
 540     {
 541       GNUNET_SERVER_client_drop (session->client);
 542       session->client = NULL;
 543     }
 544   GNUNET_free_non_null (session->connect_addr);
 545   GNUNET_free (session);
 546 }
 547
 548
 549 /**
 550  * Function that can be used by the transport service to transmit
 551  * a message using the plugin.   Note that in the case of a
 552  * peer disconnecting, the continuation MUST be called
 553  * prior to the disconnect notification itself.  This function
 554  * will be called with this peer's HELLO message to initiate
 555  * a fresh connection to another peer.
 556  *
 557  * @param cls closure
 558  * @param target who should receive this message
 559  * @param msg the message to transmit
 560  * @param priority how important is the message (most plugins will
 561  *                 ignore message priority and just FIFO)
 562  * @param timeout how long to wait at most for the transmission (does not
 563  *                require plugins to discard the message after the timeout,
 564  *                just advisory for the desired delay; most plugins will ignore
 565  *                this as well)
 566  * @param addr the address to use (can be NULL if the plugin
 567  *                is "on its own" (i.e. re-use existing TCP connection))
 568  * @param addrlen length of the address in bytes
 569  * @param force_address GNUNET_YES if the plugin MUST use the given address,
 570  *                otherwise the plugin may use other addresses or
 571  *                existing connections (if available)
 572  * @param cont continuation to call once the message has
 573  *        been transmitted (or if the transport is ready
 574  *        for the next transmission call; or if the
 575  *        peer disconnected...); can be NULL
 576  * @param cont_cls closure for cont
 577  * @return number of bytes used (on the physical network, with overheads);
 578  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
 579  *         and does NOT mean that the message was not transmitted (DV)
 580  */
 581 static ssize_t
 582 tcp_plugin_send (void *cls,
 583                  const struct GNUNET_PeerIdentity *target,
 584                  const char *msg,
 585                  size_t msgbuf_size,
 586                  uint32_t priority,
 587                  struct GNUNET_TIME_Relative timeout,
 588                  const void *addr,
 589                  size_t addrlen,
 590                  int force_address,
 591                  GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
 592 {
 593   struct Plugin *plugin = cls;
 594   struct Session *session;
 595   struct PendingMessage *pm;
 596   struct GNUNET_CONNECTION_Handle *sa;
 597   int af;
 598
 599   session = plugin->sessions;
 600   while ( (session != NULL) &&
 601           ( (0 != memcmp (target,
 602                           &session->target,
 603                           sizeof (struct GNUNET_PeerIdentity))) ||
 604             ( (GNUNET_YES == force_address) &&
 605               (addr != NULL) &&
 606               ( (addrlen != session->connect_alen) ||
 607                 (0 != memcmp (session->connect_addr,
 608                               addr,
 609                               addrlen)) ) ) ) )
 610     session = session->next;
 611   if ( (session == NULL) &&
 612        (addr == NULL) )
 613     {
 614 #if DEBUG_TCP
 615       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 616                        "tcp",
 617                        "Asked to transmit to `%4s' without address and I have no existing connection (failing).\n",
 618                        GNUNET_i2s (target));
 619 #endif
 620       return -1;
 621     }
 622   if (session == NULL)
 623     {
 624       if (sizeof (struct sockaddr_in) == addrlen)
 625         af = AF_INET;
 626       else if (sizeof (struct sockaddr_in6) == addrlen)
 627         af = AF_INET6;
 628       else
 629         {
 630           GNUNET_break_op (0);
 631           return -1;
 632         }
 633       sa = GNUNET_CONNECTION_create_from_sockaddr (plugin->env->sched,
 634                                                    af, addr, addrlen,
 635                                                    GNUNET_SERVER_MAX_MESSAGE_SIZE);
 636       if (sa == NULL)
 637         {
 638 #if DEBUG_TCP
 639           GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 640                            "tcp",
 641                            "Failed to create connection to `%4s' at `%s'\n",
 642                            GNUNET_i2s (target),
 643                            GNUNET_a2s (addr, addrlen));
 644 #endif
 645           return -1;
 646         }
 647
 648 #if DEBUG_TCP
 649       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 650                        "tcp",
 651                        "Asked to transmit to `%4s', creating fresh session using address `%s'.\n",
 652                        GNUNET_i2s (target),
 653                        GNUNET_a2s (addr, addrlen));
 654 #endif
 655       session = create_session (plugin,
 656                                 target,
 657                                 GNUNET_SERVER_connect_socket (plugin->server,
 658                                                               sa));
 659       session->connect_addr = GNUNET_malloc (addrlen);
 660       memcpy (session->connect_addr,
 661               addr,
 662               addrlen);
 663       session->connect_alen = addrlen;
 664     }
 665   GNUNET_assert (session != NULL);
 666   GNUNET_assert (session->client != NULL);
 667
 668   /* create new message entry */
 669   pm = GNUNET_malloc (sizeof (struct PendingMessage) + msgbuf_size);
 670   pm->msg = (const char*) &pm[1];
 671   memcpy (&pm[1], msg, msgbuf_size);
 672   pm->message_size = msgbuf_size;
 673   pm->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 674   pm->transmit_cont = cont;
 675   pm->transmit_cont_cls = cont_cls;
 676
 677   /* append pm to pending_messages list */
 678   GNUNET_CONTAINER_DLL_insert_after (session->pending_messages_head,
 679                                      session->pending_messages_tail,
 680                                      session->pending_messages_tail,
 681                                      pm);
 682 #if DEBUG_TCP
 683   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 684                    "tcp",
 685                    "Asked to transmit %u bytes to `%s', added message to list.\n",
 686                    msgbuf_size,
 687                    GNUNET_i2s (target));
 688 #endif
 689   process_pending_messages (session);
 690   return msgbuf_size;
 691 }
 692
 693
 694 /**
 695  * Function that can be called to force a disconnect from the
 696  * specified neighbour.  This should also cancel all previously
 697  * scheduled transmissions.  Obviously the transmission may have been
 698  * partially completed already, which is OK.  The plugin is supposed
 699  * to close the connection (if applicable) and no longer call the
 700  * transmit continuation(s).
 701  *
 702  * Finally, plugin MUST NOT call the services's receive function to
 703  * notify the service that the connection to the specified target was
 704  * closed after a getting this call.
 705  *
 706  * @param cls closure
 707  * @param target peer for which the last transmission is
 708  *        to be cancelled
 709  */
 710 static void
 711 tcp_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
 712 {
 713   struct Plugin *plugin = cls;
 714   struct Session *session;
 715   struct PendingMessage *pm;
 716
 717 #if DEBUG_TCP
 718   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 719                    "tcp",
 720                    "Asked to cancel session with `%4s'\n",
 721                    GNUNET_i2s (target));
 722 #endif
 723   session = plugin->sessions;
 724   while (NULL != session)
 725     {
 726       if (0 == memcmp (target,
 727                        &session->target,
 728                        sizeof (struct GNUNET_PeerIdentity)))
 729         {
 730           pm = session->pending_messages_head;
 731           while (pm != NULL)
 732             {
 733               pm->transmit_cont = NULL;
 734               pm->transmit_cont_cls = NULL;
 735               pm = pm->next;
 736             }
 737           if (session->client != NULL)
 738             {
 739               GNUNET_SERVER_client_drop (session->client);
 740               session->client = NULL;
 741             }
 742           /* rest of the clean-up of the session will be done as part of
 743              disconnect_notify which should be triggered any time now
 744              (or which may be triggering this call in the first place) */
 745         }
 746       session = session->next;
 747     }
 748 }
 749
 750
 751 struct PrettyPrinterContext
 752 {
 753   GNUNET_TRANSPORT_AddressStringCallback asc;
 754   void *asc_cls;
 755   uint16_t port;
 756 };
 757
 758
 759 /**
 760  * Append our port and forward the result.
 761  */
 762 static void
 763 append_port (void *cls, const char *hostname)
 764 {
 765   struct PrettyPrinterContext *ppc = cls;
 766   char *ret;
 767
 768   if (hostname == NULL)
 769     {
 770       ppc->asc (ppc->asc_cls, NULL);
 771       GNUNET_free (ppc);
 772       return;
 773     }
 774   GNUNET_asprintf (&ret, "%s:%d", hostname, ppc->port);
 775   ppc->asc (ppc->asc_cls, ret);
 776   GNUNET_free (ret);
 777 }
 778
 779
 780 /**
 781  * Convert the transports address to a nice, human-readable
 782  * format.
 783  *
 784  * @param cls closure
 785  * @param type name of the transport that generated the address
 786  * @param addr one of the addresses of the host, NULL for the last address
 787  *        the specific address format depends on the transport
 788  * @param addrlen length of the address
 789  * @param numeric should (IP) addresses be displayed in numeric form?
 790  * @param timeout after how long should we give up?
 791  * @param asc function to call on each string
 792  * @param asc_cls closure for asc
 793  */
 794 static void
 795 tcp_plugin_address_pretty_printer (void *cls,
 796                                    const char *type,
 797                                    const void *addr,
 798                                    size_t addrlen,
 799                                    int numeric,
 800                                    struct GNUNET_TIME_Relative timeout,
 801                                    GNUNET_TRANSPORT_AddressStringCallback asc,
 802                                    void *asc_cls)
 803 {
 804   struct Plugin *plugin = cls;
 805   const struct sockaddr_in *v4;
 806   const struct sockaddr_in6 *v6;
 807   struct PrettyPrinterContext *ppc;
 808
 809   if ((addrlen != sizeof (struct sockaddr_in)) &&
 810       (addrlen != sizeof (struct sockaddr_in6)))
 811     {
 812       /* invalid address */
 813       GNUNET_break_op (0);
 814       asc (asc_cls, NULL);
 815       return;
 816     }
 817   ppc = GNUNET_malloc (sizeof (struct PrettyPrinterContext));
 818   ppc->asc = asc;
 819   ppc->asc_cls = asc_cls;
 820   if (addrlen == sizeof (struct sockaddr_in))
 821     {
 822       v4 = (const struct sockaddr_in *) addr;
 823       ppc->port = ntohs (v4->sin_port);
 824     }
 825   else
 826     {
 827       v6 = (const struct sockaddr_in6 *) addr;
 828       ppc->port = ntohs (v6->sin6_port);
 829
 830     }
 831   GNUNET_RESOLVER_hostname_get (plugin->env->sched,
 832                                 plugin->env->cfg,
 833                                 addr,
 834                                 addrlen,
 835                                 !numeric, timeout, &append_port, ppc);
 836 }
 837
 838
 839 /**
 840  * Update the last-received and bandwidth quota values
 841  * for this session.
 842  *
 843  * @param session session to update
 844  * @param force set to GNUNET_YES if we should update even
 845  *        though the minimum refresh time has not yet expired
 846  */
 847 static void
 848 update_quota (struct Session *session, int force)
 849 {
 850   struct GNUNET_TIME_Absolute now;
 851   unsigned long long delta;
 852   unsigned long long total_allowed;
 853   unsigned long long total_remaining;
 854
 855   now = GNUNET_TIME_absolute_get ();
 856   delta = now.value - session->last_quota_update.value;
 857   if ((delta < MIN_QUOTA_REFRESH_TIME) && (!force))
 858     return;                     /* too early, not enough data */
 859
 860   total_allowed = session->quota_in * delta;
 861   if (total_allowed > session->last_received)
 862     {
 863       /* got less than acceptable */
 864       total_remaining = total_allowed - session->last_received;
 865       session->last_received = 0;
 866       delta = total_remaining / session->quota_in;      /* bonus seconds */
 867       if (delta > MAX_BANDWIDTH_CARRY)
 868         delta = MAX_BANDWIDTH_CARRY;    /* limit amount of carry-over */
 869     }
 870   else
 871     {
 872       /* got more than acceptable */
 873       session->last_received -= total_allowed;
 874       delta = 0;
 875     }
 876   session->last_quota_update.value = now.value - delta;
 877 }
 878
 879
 880 /**
 881  * Set a quota for receiving data from the given peer; this is a
 882  * per-transport limit.  The transport should limit its read/select
 883  * calls to stay below the quota (in terms of incoming data).
 884  *
 885  * @param cls closure
 886  * @param target the peer for whom the quota is given
 887  * @param quota_in quota for receiving/sending data in bytes per ms
 888  */
 889 static void
 890 tcp_plugin_set_receive_quota (void *cls,
 891                               const struct GNUNET_PeerIdentity *target,
 892                               uint32_t quota_in)
 893 {
 894   struct Plugin *plugin = cls;
 895   struct Session *session;
 896
 897   session = find_session_by_target (plugin, target);
 898   if (session == NULL)
 899     return;                     /* peer must have disconnected, ignore */
 900   if (session->quota_in != quota_in)
 901     {
 902       update_quota (session, GNUNET_YES);
 903       if (session->quota_in > quota_in)
 904         session->last_quota_update = GNUNET_TIME_absolute_get ();
 905       session->quota_in = quota_in;
 906     }
 907 }
 908
 909
 910 /**
 911  * Check if the given port is plausible (must be either
 912  * our listen port or our advertised port).  If it is
 913  * neither, we return one of these two ports at random.
 914  *
 915  * @return either in_port or a more plausible port
 916  */
 917 static uint16_t
 918 check_port (struct Plugin *plugin, uint16_t in_port)
 919 {
 920   if ((in_port == plugin->adv_port) || (in_port == plugin->open_port))
 921     return in_port;
 922   return (GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
 923                                     2) == 0)
 924     ? plugin->open_port : plugin->adv_port;
 925 }
 926
 927
 928 /**
 929  * Another peer has suggested an address for this peer and transport
 930  * plugin.  Check that this could be a valid address.
 931  *
 932  * @param cls closure
 933  * @param addr pointer to the address
 934  * @param addrlen length of addr
 935  * @return GNUNET_OK if this is a plausible address for this peer
 936  *         and transport
 937  */
 938 static int
 939 tcp_plugin_check_address (void *cls, void *addr, size_t addrlen)
 940 {
 941   struct Plugin *plugin = cls;
 942   char buf[sizeof (struct sockaddr_in6)];
 943   struct sockaddr_in *v4;
 944   struct sockaddr_in6 *v6;
 945
 946   if ((addrlen != sizeof (struct sockaddr_in)) &&
 947       (addrlen != sizeof (struct sockaddr_in6)))
 948     {
 949       GNUNET_break_op (0);
 950       return GNUNET_SYSERR;
 951     }
 952   memcpy (buf, addr, sizeof (struct sockaddr_in6));
 953   if (addrlen == sizeof (struct sockaddr_in))
 954     {
 955       v4 = (struct sockaddr_in *) buf;
 956       v4->sin_port = htons (check_port (plugin, ntohs (v4->sin_port)));
 957     }
 958   else
 959     {
 960       v6 = (struct sockaddr_in6 *) buf;
 961       v6->sin6_port = htons (check_port (plugin, ntohs (v6->sin6_port)));
 962     }
 963 #if DEBUG_TCP
 964   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 965                    "tcp",
 966                    "Informing transport service about my address `%s'.\n",
 967                    GNUNET_a2s (addr, addrlen));
 968 #endif
 969   return GNUNET_OK;
 970 }
 971
 972
 973 /**
 974  * We've received a welcome from this peer via TCP.  Possibly create a
 975  * fresh client record and send back our welcome.
 976  *
 977  * @param cls closure
 978  * @param client identification of the client
 979  * @param message the actual message
 980  */
 981 static void
 982 handle_tcp_welcome (void *cls,
 983                     struct GNUNET_SERVER_Client *client,
 984                     const struct GNUNET_MessageHeader *message)
 985 {
 986   struct Plugin *plugin = cls;
 987   const struct WelcomeMessage *wm = (const struct WelcomeMessage *) message;
 988   struct Session *session;
 989   size_t alen;
 990   void *vaddr;
 991
 992 #if DEBUG_TCP
 993   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 994                    "tcp",
 995                    "Received %s message from a `%4s/%p'.\n",
 996                    "WELCOME",
 997                    GNUNET_i2s (&wm->clientIdentity), client);
 998 #endif
 999   session = find_session_by_client (plugin, client);
1000   if (session == NULL)
1001     {
1002       GNUNET_SERVER_client_keep (client);
1003       session = create_session (plugin,
1004                                 &wm->clientIdentity, client);
1005       if (GNUNET_OK ==
1006           GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
1007         {
1008 #if DEBUG_TCP
1009           GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
1010                            "tcp",
1011                            "Found address `%s' for incoming connection %p\n",
1012                            GNUNET_a2s (vaddr, alen),
1013                            client);
1014 #endif
1015           session->connect_addr = vaddr;
1016           session->connect_alen = alen;
1017         }
1018       else
1019         {
1020 #if DEBUG_TCP
1021           GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
1022                            "tcp",
1023                            "Did not obtain TCP socket address for incoming connection\n");
1024 #endif
1025         }
1026 #if DEBUG_TCP
1027       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
1028                        "tcp",
1029                        "Creating new session %p for connection %p\n",
1030                        session, client);
1031 #endif
1032       process_pending_messages (session);
1033     }
1034   if (session->expecting_welcome != GNUNET_YES)
1035     {
1036       GNUNET_break_op (0);
1037       GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1038       return;
1039     }
1040   session->expecting_welcome = GNUNET_NO;
1041   GNUNET_SERVER_receive_done (client, GNUNET_OK);
1042 }
1043
1044
1045 /**
1046  * Calculate how long we should delay reading from the TCP socket to
1047  * ensure that we stay within our bandwidth limits (push back).
1048  *
1049  * @param session for which client should this be calculated
1050  */
1051 static struct GNUNET_TIME_Relative
1052 calculate_throttle_delay (struct Session *session)
1053 {
1054   struct GNUNET_TIME_Relative ret;
1055   struct GNUNET_TIME_Absolute now;
1056   uint64_t del;
1057   uint64_t avail;
1058   uint64_t excess;
1059
1060   now = GNUNET_TIME_absolute_get ();
1061   del = now.value - session->last_quota_update.value;
1062   if (del > MAX_BANDWIDTH_CARRY)
1063     {
1064       update_quota (session, GNUNET_YES);
1065       del = now.value - session->last_quota_update.value;
1066       GNUNET_assert (del <= MAX_BANDWIDTH_CARRY);
1067     }
1068   if (session->quota_in == 0)
1069     session->quota_in = 1;      /* avoid divison by zero */
1070   avail = del * session->quota_in;
1071   if (avail > session->last_received)
1072     return GNUNET_TIME_UNIT_ZERO;       /* can receive right now */
1073   excess = session->last_received - avail;
1074   ret.value = excess / session->quota_in;
1075   return ret;
1076 }
1077
1078
1079 /**
1080  * Task to signal the server that we can continue
1081  * receiving from the TCP client now.
1082  */
1083 static void
1084 delayed_done (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1085 {
1086   struct Session *session = cls;
1087   GNUNET_SERVER_receive_done (session->client, GNUNET_OK);
1088 }
1089
1090
1091 /**
1092  * We've received data for this peer via TCP.  Unbox,
1093  * compute latency and forward.
1094  *
1095  * @param cls closure
1096  * @param client identification of the client
1097  * @param message the actual message
1098  */
1099 static void
1100 handle_tcp_data (void *cls,
1101                  struct GNUNET_SERVER_Client *client,
1102                  const struct GNUNET_MessageHeader *message)
1103 {
1104   struct Plugin *plugin = cls;
1105   struct Session *session;
1106   uint16_t msize;
1107   struct GNUNET_TIME_Relative delay;
1108
1109   msize = ntohs (message->size);
1110   session = find_session_by_client (plugin, client);
1111
1112   if (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME == ntohs(message->type))
1113     {
1114       /* We don't want to propagate WELCOME messages up! */
1115       GNUNET_SERVER_receive_done (client, GNUNET_OK);
1116       return;
1117     }
1118   if ( (NULL == session) || (GNUNET_NO != session->expecting_welcome))
1119     {
1120       GNUNET_break_op (0);
1121       GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1122       return;
1123     }
1124 #if DEBUG_TCP
1125   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
1126                    "tcp",
1127                    "Passing %u bytes of type %u from `%4s' to transport service.\n",
1128                    (unsigned int) msize,
1129                    (unsigned int) ntohs (message->type),
1130                    GNUNET_i2s (&session->target));
1131 #endif
1132   plugin->env->receive (plugin->env->cls, &session->target, message, 1,
1133                         session->connect_addr,
1134                         session->connect_alen);
1135   /* update bandwidth used */
1136   session->last_received += msize;
1137   update_quota (session, GNUNET_NO);
1138   delay = calculate_throttle_delay (session);
1139   if (delay.value == 0)
1140     GNUNET_SERVER_receive_done (client, GNUNET_OK);
1141   else
1142     GNUNET_SCHEDULER_add_delayed (session->plugin->env->sched,
1143                                   delay, &delayed_done, session);
1144 }
1145
1146
1147 /**
1148  * Handlers for the various TCP messages.
1149  */
1150 static struct GNUNET_SERVER_MessageHandler my_handlers[] = {
1151   {&handle_tcp_welcome, NULL, GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME,
1152    sizeof (struct WelcomeMessage)},
1153   {&handle_tcp_data, NULL, GNUNET_MESSAGE_TYPE_ALL, 0},
1154   {NULL, NULL, 0, 0}
1155 };
1156
1157
1158 /**
1159  * Functions with this signature are called whenever a peer
1160  * is disconnected on the network level.
1161  *
1162  * @param cls closure
1163  * @param client identification of the client
1164  */
1165 static void
1166 disconnect_notify (void *cls, struct GNUNET_SERVER_Client *client)
1167 {
1168   struct Plugin *plugin = cls;
1169   struct Session *session;
1170
1171   if (client == NULL)
1172     return;
1173   session = find_session_by_client (plugin, client);
1174   if (session == NULL)
1175     return;                     /* unknown, nothing to do */
1176 #if DEBUG_TCP
1177   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
1178                    "tcp",
1179                    "Destroying session of `%4s' with %s (%p) due to network-level disconnect.\n",
1180                    GNUNET_i2s (&session->target),
1181                    (session->connect_addr != NULL) ?
1182                    GNUNET_a2s (session->connect_addr,
1183                                session->connect_alen) : "*", client);
1184 #endif
1185   disconnect_session (session);
1186 }
1187
1188
1189 /**
1190  * Add the IP of our network interface to the list of
1191  * our external IP addresses.
1192  */
1193 static int
1194 process_interfaces (void *cls,
1195                     const char *name,
1196                     int isDefault,
1197                     const struct sockaddr *addr, socklen_t addrlen)
1198 {
1199   struct Plugin *plugin = cls;
1200   int af;
1201   struct sockaddr_in *v4;
1202   struct sockaddr_in6 *v6;
1203
1204   af = addr->sa_family;
1205   if (af == AF_INET)
1206     {
1207       v4 = (struct sockaddr_in *) addr;
1208       v4->sin_port = htons (plugin->adv_port);
1209     }
1210   else
1211     {
1212       GNUNET_assert (af == AF_INET6);
1213       v6 = (struct sockaddr_in6 *) addr;
1214       v6->sin6_port = htons (plugin->adv_port);
1215     }
1216   GNUNET_log_from (GNUNET_ERROR_TYPE_INFO |
1217                    GNUNET_ERROR_TYPE_BULK,
1218                    "tcp", _("Found address `%s' (%s)\n"),
1219                    GNUNET_a2s (addr, addrlen), name);
1220   plugin->env->notify_address (plugin->env->cls,
1221                                "tcp",
1222                                addr, addrlen, GNUNET_TIME_UNIT_FOREVER_REL);
1223   return GNUNET_OK;
1224 }
1225
1226
1227 /**
1228  * Function called by the resolver for each address obtained from DNS
1229  * for our own hostname.  Add the addresses to the list of our
1230  * external IP addresses.
1231  *
1232  * @param cls closure
1233  * @param addr one of the addresses of the host, NULL for the last address
1234  * @param addrlen length of the address
1235  */
1236 static void
1237 process_hostname_ips (void *cls,
1238                       const struct sockaddr *addr, socklen_t addrlen)
1239 {
1240   struct Plugin *plugin = cls;
1241
1242   if (addr == NULL)
1243     {
1244       plugin->hostname_dns = NULL;
1245       return;
1246     }
1247   process_interfaces (plugin, "<hostname>", GNUNET_YES, addr, addrlen);
1248 }
1249
1250
1251 /**
1252  * Entry point for the plugin.
1253  */
1254 void *
1255 libgnunet_plugin_transport_tcp_init (void *cls)
1256 {
1257   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1258   struct GNUNET_TRANSPORT_PluginFunctions *api;
1259   struct Plugin *plugin;
1260   struct GNUNET_SERVICE_Context *service;
1261   unsigned long long aport;
1262   unsigned long long bport;
1263   unsigned int i;
1264
1265   service = GNUNET_SERVICE_start ("transport-tcp", env->sched, env->cfg);
1266   if (service == NULL)
1267     {
1268       GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING,
1269                        "tcp",
1270                        _
1271                        ("Failed to start service for `%s' transport plugin.\n"),
1272                        "tcp");
1273       return NULL;
1274     }
1275   aport = 0;
1276   if ((GNUNET_OK !=
1277        GNUNET_CONFIGURATION_get_value_number (env->cfg,
1278                                               "transport-tcp",
1279                                               "PORT",
1280                                               &bport)) ||
1281       (bport > 65535) ||
1282       ((GNUNET_OK ==
1283         GNUNET_CONFIGURATION_get_value_number (env->cfg,
1284                                                "transport-tcp",
1285                                                "ADVERTISED-PORT",
1286                                                &aport)) && (aport > 65535)))
1287     {
1288       GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
1289                        "tcp",
1290                        _
1291                        ("Require valid port number for service `%s' in configuration!\n"),
1292                        "transport-tcp");
1293       GNUNET_SERVICE_stop (service);
1294       return NULL;
1295     }
1296   if (aport == 0)
1297     aport = bport;
1298   plugin = GNUNET_malloc (sizeof (struct Plugin));
1299   plugin->open_port = bport;
1300   plugin->adv_port = aport;
1301   plugin->env = env;
1302   plugin->lsock = NULL;
1303   plugin->statistics = NULL;
1304   api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1305   api->cls = plugin;
1306   api->send = &tcp_plugin_send;
1307   api->disconnect = &tcp_plugin_disconnect;
1308   api->address_pretty_printer = &tcp_plugin_address_pretty_printer;
1309   api->set_receive_quota = &tcp_plugin_set_receive_quota;
1310   api->check_address = &tcp_plugin_check_address;
1311   plugin->service = service;
1312   plugin->server = GNUNET_SERVICE_get_server (service);
1313   plugin->handlers = GNUNET_malloc (sizeof (my_handlers));
1314   memcpy (plugin->handlers, my_handlers, sizeof (my_handlers));
1315   for (i = 0;
1316        i <
1317        sizeof (my_handlers) / sizeof (struct GNUNET_SERVER_MessageHandler);
1318        i++)
1319     plugin->handlers[i].callback_cls = plugin;
1320   GNUNET_SERVER_add_handlers (plugin->server, plugin->handlers);
1321
1322   GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
1323                    "tcp", _("TCP transport listening on port %llu\n"), bport);
1324   if (aport != bport)
1325     GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
1326                      "tcp",
1327                      _
1328                      ("TCP transport advertises itself as being on port %llu\n"),
1329                      aport);
1330   GNUNET_SERVER_disconnect_notify (plugin->server, &disconnect_notify,
1331                                    plugin);
1332   /* FIXME: do the two calls below periodically again and
1333      not just once (since the info we get might change...) */
1334   GNUNET_OS_network_interfaces_list (&process_interfaces, plugin);
1335   plugin->hostname_dns = GNUNET_RESOLVER_hostname_resolve (env->sched,
1336                                                            env->cfg,
1337                                                            AF_UNSPEC,
1338                                                            HOSTNAME_RESOLVE_TIMEOUT,
1339                                                            &process_hostname_ips,
1340                                                            plugin);
1341   return api;
1342 }
1343
1344
1345 /**
1346  * Exit point from the plugin.
1347  */
1348 void *
1349 libgnunet_plugin_transport_tcp_done (void *cls)
1350 {
1351   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1352   struct Plugin *plugin = api->cls;
1353   struct Session *session;
1354
1355   while (NULL != (session = plugin->sessions))
1356     disconnect_session (session);
1357   if (NULL != plugin->hostname_dns)
1358     {
1359       GNUNET_RESOLVER_request_cancel (plugin->hostname_dns);
1360       plugin->hostname_dns = NULL;
1361     }
1362   GNUNET_SERVICE_stop (plugin->service);
1363   GNUNET_free (plugin->handlers);
1364   GNUNET_free (plugin);
1365   GNUNET_free (api);
1366   return NULL;
1367 }
1368
1369 /* end of plugin_transport_tcp.c */