src/transport/gnunet-service-transport_clients.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010,2011 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 /**
  22  * @file transport/gnunet-service-transport_clients.c
  23  * @brief plugin management API
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet-service-transport_blacklist.h"
  28 #include "gnunet-service-transport_clients.h"
  29 #include "gnunet-service-transport_hello.h"
  30 #include "gnunet-service-transport_neighbours.h"
  31 #include "gnunet-service-transport_plugins.h"
  32 #include "gnunet-service-transport_validation.h"
  33 #include "gnunet-service-transport.h"
  34 #include "transport.h"
  35
  36 /**
  37  * How many messages can we have pending for a given client process
  38  * before we start to drop incoming messages?  We typically should
  39  * have only one client and so this would be the primary buffer for
  40   * messages, so the number should be chosen rather generously.
  41  *
  42  * The expectation here is that most of the time the queue is large
  43  * enough so that a drop is virtually never required.  Note that
  44  * this value must be about as large as 'TOTAL_MSGS' in the
  45  * 'test_transport_api_reliability.c', otherwise that testcase may
  46  * fail.
  47  */
  48 #define MAX_PENDING (128 * 1024)
  49
  50
  51 /**
  52  * Linked list of messages to be transmitted to the client.  Each
  53  * entry is followed by the actual message.
  54  */
  55 struct ClientMessageQueueEntry
  56 {
  57   /**
  58    * This is a doubly-linked list.
  59    */
  60   struct ClientMessageQueueEntry *next;
  61
  62   /**
  63    * This is a doubly-linked list.
  64    */
  65   struct ClientMessageQueueEntry *prev;
  66 };
  67
  68
  69 /**
  70  * Client connected to the transport service.
  71  */
  72 struct TransportClient
  73 {
  74
  75   /**
  76    * This is a doubly-linked list.
  77    */
  78   struct TransportClient *next;
  79
  80   /**
  81    * This is a doubly-linked list.
  82    */
  83   struct TransportClient *prev;
  84
  85   /**
  86    * Handle to the client.
  87    */
  88   struct GNUNET_SERVER_Client *client;
  89
  90   /**
  91    * Linked list of messages yet to be transmitted to
  92    * the client.
  93    */
  94   struct ClientMessageQueueEntry *message_queue_head;
  95
  96   /**
  97    * Tail of linked list of messages yet to be transmitted to the
  98    * client.
  99    */
 100   struct ClientMessageQueueEntry *message_queue_tail;
 101
 102   /**
 103    * Current transmit request handle.
 104    */
 105   struct GNUNET_CONNECTION_TransmitHandle *th;
 106
 107   /**
 108    * Length of the list of messages pending for this client.
 109    */
 110   unsigned int message_count;
 111 };
 112
 113
 114 /**
 115  * Head of linked list of all clients to this service.
 116  */
 117 static struct TransportClient *clients_head;
 118
 119 /**
 120  * Tail of linked list of all clients to this service.
 121  */
 122 static struct TransportClient *clients_tail;
 123
 124 /**
 125  * Find the internal handle associated with the given client handle
 126  *
 127  * @param client server's client handle to look up
 128  * @return internal client handle
 129  */
 130 static struct TransportClient *
 131 lookup_client (struct GNUNET_SERVER_Client *client)
 132 {
 133   struct TransportClient *tc;
 134
 135   tc = clients_head;
 136   while (tc != NULL)
 137   {
 138     if (tc->client == client)
 139       return tc;
 140     tc = tc->next;
 141   }
 142   return NULL;
 143 }
 144
 145
 146 /**
 147  * Create the internal handle for the given server client handle
 148  *
 149  * @param client server's client handle to create our internal handle for
 150  * @return fresh internal client handle
 151  */
 152 static struct TransportClient *
 153 setup_client (struct GNUNET_SERVER_Client *client)
 154 {
 155   struct TransportClient *tc;
 156
 157   GNUNET_assert (lookup_client (client) == NULL);
 158   tc = GNUNET_malloc (sizeof (struct TransportClient));
 159   tc->client = client;
 160   GNUNET_CONTAINER_DLL_insert (clients_head, clients_tail, tc);
 161
 162 #if DEBUG_TRANSPORT
 163   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 164                "Client %X connected\n", tc);
 165 #endif
 166   return tc;
 167 }
 168
 169
 170 /**
 171  * Function called to notify a client about the socket being ready to
 172  * queue more data.  "buf" will be NULL and "size" zero if the socket
 173  * was closed for writing in the meantime.
 174  *
 175  * @param cls closure
 176  * @param size number of bytes available in buf
 177  * @param buf where the callee should write the message
 178  * @return number of bytes written to buf
 179  */
 180 static size_t
 181 transmit_to_client_callback (void *cls, size_t size, void *buf)
 182 {
 183   struct TransportClient *tc = cls;
 184   struct ClientMessageQueueEntry *q;
 185   const struct GNUNET_MessageHeader *msg;
 186   char *cbuf;
 187   uint16_t msize;
 188   size_t tsize;
 189
 190   tc->th = NULL;
 191   if (buf == NULL)
 192   {
 193 #if DEBUG_TRANSPORT
 194     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 195                 "Transmission to client failed, closing connection.\n");
 196 #endif
 197     return 0;
 198   }
 199   cbuf = buf;
 200   tsize = 0;
 201   while (NULL != (q = tc->message_queue_head))
 202   {
 203     msg = (const struct GNUNET_MessageHeader *) &q[1];
 204     msize = ntohs (msg->size);
 205     if (msize + tsize > size)
 206       break;
 207 #if DEBUG_TRANSPORT
 208     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 209                 "Transmitting message of type %u to client %X.\n",
 210                 ntohs (msg->type), tc);
 211 #endif
 212     GNUNET_CONTAINER_DLL_remove (tc->message_queue_head, tc->message_queue_tail,
 213                                  q);
 214     tc->message_count--;
 215     memcpy (&cbuf[tsize], msg, msize);
 216     GNUNET_free (q);
 217     tsize += msize;
 218   }
 219   if (NULL != q)
 220   {
 221     GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
 222     tc->th =
 223         GNUNET_SERVER_notify_transmit_ready (tc->client, msize,
 224                                              GNUNET_TIME_UNIT_FOREVER_REL,
 225                                              &transmit_to_client_callback, tc);
 226     GNUNET_assert (tc->th != NULL);
 227   }
 228   return tsize;
 229 }
 230
 231
 232 /**
 233  * Queue the given message for transmission to the given client
 234  *
 235  * @param tc target of the message
 236  * @param msg message to transmit
 237  * @param may_drop GNUNET_YES if the message can be dropped
 238  */
 239 static void
 240 unicast (struct TransportClient *tc, const struct GNUNET_MessageHeader *msg,
 241          int may_drop)
 242 {
 243   struct ClientMessageQueueEntry *q;
 244   uint16_t msize;
 245
 246   if ((tc->message_count >= MAX_PENDING) && (GNUNET_YES == may_drop))
 247   {
 248     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 249                 _
 250                 ("Dropping message of type %u and size %u, have %u/%u messages pending\n"),
 251                 ntohs (msg->type), ntohs (msg->size), tc->message_count,
 252                 MAX_PENDING);
 253     GNUNET_STATISTICS_update (GST_stats,
 254                               gettext_noop
 255                               ("# messages dropped due to slow client"), 1,
 256                               GNUNET_NO);
 257     return;
 258   }
 259   msize = ntohs (msg->size);
 260   GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
 261   q = GNUNET_malloc (sizeof (struct ClientMessageQueueEntry) + msize);
 262   memcpy (&q[1], msg, msize);
 263   GNUNET_CONTAINER_DLL_insert_tail (tc->message_queue_head,
 264                                     tc->message_queue_tail, q);
 265   tc->message_count++;
 266   if (tc->th != NULL)
 267     return;
 268   tc->th =
 269       GNUNET_SERVER_notify_transmit_ready (tc->client, msize,
 270                                            GNUNET_TIME_UNIT_FOREVER_REL,
 271                                            &transmit_to_client_callback, tc);
 272   GNUNET_assert (tc->th != NULL);
 273 }
 274
 275
 276 /**
 277  * Called whenever a client is disconnected.  Frees our
 278  * resources associated with that client.
 279  *
 280  * @param cls closure
 281  * @param client identification of the client
 282  */
 283 static void
 284 client_disconnect_notification (void *cls, struct GNUNET_SERVER_Client *client)
 285 {
 286   struct TransportClient *tc;
 287   struct ClientMessageQueueEntry *mqe;
 288
 289   if (client == NULL)
 290     return;
 291   tc = lookup_client (client);
 292   if (tc == NULL)
 293     return;
 294 #if DEBUG_TRANSPORT
 295   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
 296               "Client %X disconnected, cleaning up.\n", tc);
 297 #endif
 298   while (NULL != (mqe = tc->message_queue_head))
 299   {
 300     GNUNET_CONTAINER_DLL_remove (tc->message_queue_head, tc->message_queue_tail,
 301                                  mqe);
 302     tc->message_count--;
 303     GNUNET_free (mqe);
 304   }
 305   GNUNET_CONTAINER_DLL_remove (clients_head, clients_tail, tc);
 306   if (tc->th != NULL)
 307   {
 308     GNUNET_CONNECTION_notify_transmit_ready_cancel (tc->th);
 309     tc->th = NULL;
 310   }
 311   GNUNET_break (0 == tc->message_count);
 312   GNUNET_free (tc);
 313 }
 314
 315
 316 /**
 317  * Function called for each of our connected neighbours.  Notify the
 318  * client about the existing neighbour.
 319  *
 320  * @param cls the 'struct TransportClient' to notify
 321  * @param peer identity of the neighbour
 322  * @param ats performance data
 323  * @param ats_count number of entries in ats (excluding 0-termination)
 324  * @param transport plugin
 325  * @param addr address
 326  * @param addrlen address length
 327  */
 328 static void
 329 notify_client_about_neighbour (void *cls,
 330                                const struct GNUNET_PeerIdentity *peer,
 331                                const struct GNUNET_TRANSPORT_ATS_Information
 332                                *ats, uint32_t ats_count,
 333                                const char * transport,
 334                                const void * addr,
 335                                size_t addrlen)
 336 {
 337   struct TransportClient *tc = cls;
 338   struct ConnectInfoMessage *cim;
 339   size_t size;
 340
 341   size =
 342       sizeof (struct ConnectInfoMessage) +
 343       ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information);
 344   GNUNET_assert (size < GNUNET_SERVER_MAX_MESSAGE_SIZE);
 345   cim = GNUNET_malloc (size);
 346   cim->header.size = htons (size);
 347   cim->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
 348   cim->ats_count = htonl (ats_count);
 349   cim->id = *peer;
 350   memcpy (&cim->ats, ats,
 351           ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
 352   unicast (tc, &cim->header, GNUNET_NO);
 353   GNUNET_free (cim);
 354 }
 355
 356
 357 /**
 358  * Initialize a normal client.  We got a start message from this
 359  * client, add him to the list of clients for broadcasting of inbound
 360  * messages.
 361  *
 362  * @param cls unused
 363  * @param client the client
 364  * @param message the start message that was sent
 365  */
 366 static void
 367 clients_handle_start (void *cls, struct GNUNET_SERVER_Client *client,
 368                       const struct GNUNET_MessageHeader *message)
 369 {
 370   const struct StartMessage *start;
 371   struct TransportClient *tc;
 372
 373   tc = lookup_client (client);
 374
 375 #if DEBUG_TRANSPORT
 376   if (tc != NULL)
 377     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
 378                 "Client %X sent START\n", tc);
 379   else
 380     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
 381                 "Client %X sent START\n", tc);
 382 #endif
 383   if (tc != NULL)
 384   {
 385     /* got 'start' twice from the same client, not allowed */
 386 #if DEBUG_TRANSPORT
 387     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
 388                 "TransportClient %X ServerClient %X  sent multiple START messages\n",
 389                 tc, tc->client);
 390 #endif
 391     GNUNET_break (0);
 392     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 393     return;
 394   }
 395   start = (const struct StartMessage *) message;
 396   if ((GNUNET_NO != ntohl (start->do_check)) &&
 397       (0 !=
 398        memcmp (&start->self, &GST_my_identity,
 399                sizeof (struct GNUNET_PeerIdentity))))
 400   {
 401     /* client thinks this is a different peer, reject */
 402     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 403                 _
 404                 ("Rejecting control connection from peer `%s', which is not me!\n"),
 405                 GNUNET_i2s (&start->self));
 406     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 407     return;
 408   }
 409   tc = setup_client (client);
 410
 411   unicast (tc, GST_hello_get (), GNUNET_NO);
 412   GST_neighbours_iterate (&notify_client_about_neighbour, tc);
 413   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 414 }
 415
 416
 417 /**
 418  * Client sent us a HELLO.  Process the request.
 419  *
 420  * @param cls unused
 421  * @param client the client
 422  * @param message the HELLO message
 423  */
 424 static void
 425 clients_handle_hello (void *cls, struct GNUNET_SERVER_Client *client,
 426                       const struct GNUNET_MessageHeader *message)
 427 {
 428   GST_validation_handle_hello (message);
 429   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 430 }
 431
 432
 433 /**
 434  * Closure for 'handle_send_transmit_continuation'
 435  */
 436 struct SendTransmitContinuationContext
 437 {
 438   /**
 439    * Client that made the request.
 440    */
 441   struct GNUNET_SERVER_Client *client;
 442
 443   /**
 444    * Peer that was the target.
 445    */
 446   struct GNUNET_PeerIdentity target;
 447 };
 448
 449
 450 /**
 451  * Function called after the transmission is done.  Notify the client that it is
 452  * OK to send the next message.
 453  *
 454  * @param cls closure
 455  * @param success GNUNET_OK on success, GNUNET_NO on failure, GNUNET_SYSERR if we're not connected
 456  */
 457 static void
 458 handle_send_transmit_continuation (void *cls, int success)
 459 {
 460   struct SendTransmitContinuationContext *stcc = cls;
 461   struct SendOkMessage send_ok_msg;
 462   struct TransportClient *tc;
 463
 464   send_ok_msg.header.size = htons (sizeof (send_ok_msg));
 465   send_ok_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK);
 466   send_ok_msg.success = htonl (success);
 467   send_ok_msg.latency =
 468       GNUNET_TIME_relative_hton (GNUNET_TIME_UNIT_FOREVER_REL);
 469   send_ok_msg.peer = stcc->target;
 470   GST_clients_unicast (stcc->client, &send_ok_msg.header, GNUNET_NO);
 471   GNUNET_SERVER_client_drop (stcc->client);
 472   GNUNET_free (stcc);
 473 }
 474
 475
 476 /**
 477  * Client asked for transmission to a peer.  Process the request.
 478  *
 479  * @param cls unused
 480  * @param client the client
 481  * @param message the send message that was sent
 482  */
 483 static void
 484 clients_handle_send (void *cls, struct GNUNET_SERVER_Client *client,
 485                      const struct GNUNET_MessageHeader *message)
 486 {
 487   const struct OutboundMessage *obm;
 488   const struct GNUNET_MessageHeader *obmm;
 489   struct SendTransmitContinuationContext *stcc;
 490   uint16_t size;
 491   uint16_t msize;
 492   struct TransportClient *tc;
 493
 494   tc = lookup_client (client);
 495   if (NULL == tc)
 496   {
 497     /* client asked for transmission before 'START' */
 498     GNUNET_break (0);
 499     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 500     return;
 501   }
 502
 503   size = ntohs (message->size);
 504   if (size <
 505       sizeof (struct OutboundMessage) + sizeof (struct GNUNET_MessageHeader))
 506   {
 507     GNUNET_break (0);
 508     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 509     return;
 510   }
 511   obm = (const struct OutboundMessage *) message;
 512   obmm = (const struct GNUNET_MessageHeader *) &obm[1];
 513   msize = size - sizeof (struct OutboundMessage);
 514   if (msize < sizeof (struct GNUNET_MessageHeader))
 515   {
 516     GNUNET_break (0);
 517     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 518     return;
 519   }
 520   GNUNET_STATISTICS_update (GST_stats,
 521                             gettext_noop
 522                             ("# bytes payload received for other peers"), msize,
 523                             GNUNET_NO);
 524 #if DEBUG_TRANSPORT
 525   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 526               "Received `%s' request from client with target `%4s' and first message of type %u and total size %u\n",
 527               "SEND", GNUNET_i2s (&obm->peer), ntohs (obmm->type), msize);
 528 #endif
 529   if (GNUNET_NO == GST_neighbours_test_connected (&obm->peer))
 530   {
 531     /* not connected, not allowed to send; can happen due to asynchronous operations */
 532 #if DEBUG_TRANSPORT
 533     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 534                 "Could not send message to peer `%s': not connected\n",
 535                 GNUNET_i2s (&obm->peer));
 536 #endif
 537     GNUNET_STATISTICS_update (GST_stats,
 538                               gettext_noop
 539                               ("# bytes payload dropped (other peer was not connected)"),
 540                               msize, GNUNET_NO);
 541     GNUNET_SERVER_receive_done (client, GNUNET_OK);
 542     return;
 543   }
 544   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 545   stcc = GNUNET_malloc (sizeof (struct SendTransmitContinuationContext));
 546   stcc->target = obm->peer;
 547   stcc->client = client;
 548   GNUNET_SERVER_client_keep (client);
 549   GST_neighbours_send (&obm->peer, obmm, msize,
 550                        GNUNET_TIME_relative_ntoh (obm->timeout),
 551                        &handle_send_transmit_continuation, stcc);
 552 }
 553
 554
 555 /**
 556  * Try to initiate a connection to the given peer if the blacklist
 557  * allowed it.
 558  *
 559  * @param cls closure (unused, NULL)
 560  * @param peer identity of peer that was tested
 561  * @param result GNUNET_OK if the connection is allowed,
 562  *               GNUNET_NO if not
 563  */
 564 static void
 565 try_connect_if_allowed (void *cls, const struct GNUNET_PeerIdentity *peer,
 566                         int result)
 567 {
 568   if (GNUNET_OK != result)
 569     return;                     /* not allowed */
 570   GST_neighbours_try_connect (peer);
 571 }
 572
 573
 574 /**
 575  * Handle request connect message
 576  *
 577  * @param cls closure (always NULL)
 578  * @param client identification of the client
 579  * @param message the actual message
 580  */
 581 static void
 582 clients_handle_request_connect (void *cls, struct GNUNET_SERVER_Client *client,
 583                                 const struct GNUNET_MessageHeader *message)
 584 {
 585   const struct TransportRequestConnectMessage *trcm =
 586       (const struct TransportRequestConnectMessage *) message;
 587
 588   GNUNET_STATISTICS_update (GST_stats,
 589                             gettext_noop
 590                             ("# REQUEST CONNECT messages received"), 1,
 591                             GNUNET_NO);
 592 #if DEBUG_TRANSPORT
 593   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 594               "Received a request connect message for peer `%s'\n",
 595               GNUNET_i2s (&trcm->peer));
 596 #endif
 597   (void) GST_blacklist_test_allowed (&trcm->peer, NULL, &try_connect_if_allowed,
 598                                      NULL);
 599   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 600 }
 601
 602
 603 /**
 604  * Client asked for a quota change for a particular peer.  Process the request.
 605  *
 606  * @param cls unused
 607  * @param client the client
 608  * @param message the quota changing message
 609  */
 610 static void
 611 clients_handle_set_quota (void *cls, struct GNUNET_SERVER_Client *client,
 612                           const struct GNUNET_MessageHeader *message)
 613 {
 614   const struct QuotaSetMessage *qsm;
 615
 616   qsm = (const struct QuotaSetMessage *) message;
 617   GNUNET_STATISTICS_update (GST_stats,
 618                             gettext_noop ("# SET QUOTA messages received"), 1,
 619                             GNUNET_NO);
 620 #if DEBUG_TRANSPORT
 621   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 622               "Received `%s' request (new quota %u) from client for peer `%4s'\n",
 623               "SET_QUOTA", (unsigned int) ntohl (qsm->quota.value__),
 624               GNUNET_i2s (&qsm->peer));
 625 #endif
 626   GST_neighbours_set_incoming_quota (&qsm->peer, qsm->quota);
 627   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 628 }
 629
 630
 631 /**
 632  * Take the given address and append it to the set of results sent back to
 633  * the client.
 634  *
 635  * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
 636  * @param address the resolved name, NULL to indicate the last response
 637  */
 638 static void
 639 transmit_address_to_client (void *cls, const char *buf)
 640 {
 641   struct GNUNET_SERVER_TransmitContext *tc = cls;
 642
 643   if (NULL == buf)
 644   {
 645     GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
 646                                                 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
 647     GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
 648     return;
 649   }
 650   GNUNET_SERVER_transmit_context_append_data (tc, buf, strlen (buf) + 1,
 651                                               GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
 652 }
 653
 654
 655 /**
 656  * Take the given address and append it to the set of results sent back to
 657  * the client.
 658  *
 659  * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
 660  * @param address the resolved name, NULL to indicate the last response
 661  */
 662 static void
 663 transmit_binary_to_client (void *cls, void *buf, size_t size)
 664 {
 665   struct GNUNET_SERVER_TransmitContext *tc = cls;
 666
 667   if (NULL == buf)
 668   {
 669     GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
 670                                                 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
 671     GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
 672     return;
 673   }
 674   GNUNET_SERVER_transmit_context_append_data (tc, buf, size,
 675                                               GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
 676 }
 677
 678
 679 /**
 680  * Client asked to resolve an address.  Process the request.
 681  *
 682  * @param cls unused
 683  * @param client the client
 684  * @param message the resolution request
 685  */
 686 static void
 687 clients_handle_address_lookup (void *cls, struct GNUNET_SERVER_Client *client,
 688                                const struct GNUNET_MessageHeader *message)
 689 {
 690   const struct AddressLookupMessage *alum;
 691   struct GNUNET_TRANSPORT_PluginFunctions *papi;
 692   const char *plugin_name;
 693   const char *address;
 694   uint32_t address_len;
 695   uint16_t size;
 696   struct GNUNET_SERVER_TransmitContext *tc;
 697   struct GNUNET_TIME_Relative rtimeout;
 698   int32_t numeric;
 699
 700   size = ntohs (message->size);
 701   if (size < sizeof (struct AddressLookupMessage))
 702   {
 703     GNUNET_break (0);
 704     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 705     return;
 706   }
 707   alum = (const struct AddressLookupMessage *) message;
 708   address_len = ntohl (alum->addrlen);
 709   if (size <= sizeof (struct AddressLookupMessage) + address_len)
 710   {
 711     GNUNET_break (0);
 712     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 713     return;
 714   }
 715   address = (const char *) &alum[1];
 716   plugin_name = (const char *) &address[address_len];
 717   if (plugin_name[size - sizeof (struct AddressLookupMessage) - address_len - 1]
 718       != '\0')
 719   {
 720     GNUNET_break (0);
 721     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 722     return;
 723   }
 724   rtimeout = GNUNET_TIME_relative_ntoh (alum->timeout);
 725   numeric = ntohl (alum->numeric_only);
 726   tc = GNUNET_SERVER_transmit_context_create (client);
 727   papi = GST_plugins_find (plugin_name);
 728   if (NULL == papi)
 729   {
 730     GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
 731                                                 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
 732     GNUNET_SERVER_transmit_context_run (tc, rtimeout);
 733     return;
 734   }
 735   GNUNET_SERVER_disable_receive_done_warning (client);
 736   papi->address_pretty_printer (papi->cls, plugin_name, address, address_len,
 737                                 numeric, rtimeout, &transmit_address_to_client,
 738                                 tc);
 739 }
 740
 741
 742 /**
 743  * Send an address to the client.
 744  *
 745  * @param cls our 'struct GNUNET_SERVER_TransmitContext' (for sending)
 746  * @param public_key public key for the peer, never NULL
 747  * @param target peer this change is about, never NULL
 748  * @param valid_until until what time do we consider the address valid?
 749  * @param validation_block  is FOREVER if the address is for an unsupported plugin (from PEERINFO)
 750  *                          is ZERO if the address is considered valid (no validation needed)
 751  *                          is a time in the future if we're currently denying re-validation
 752  * @param plugin_name name of the plugin
 753  * @param plugin_address binary address
 754  * @param plugin_address_len length of address
 755  */
 756 static void
 757 send_address_to_client (void *cls,
 758                         const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
 759                         *public_key, const struct GNUNET_PeerIdentity *target,
 760                         struct GNUNET_TIME_Absolute valid_until,
 761                         struct GNUNET_TIME_Absolute validation_block,
 762                         const char *plugin_name, const void *plugin_address,
 763                         size_t plugin_address_len)
 764 {
 765   struct GNUNET_SERVER_TransmitContext *tc = cls;
 766   char *addr_buf;
 767
 768   /* FIXME: move to a binary format!!! */
 769   GNUNET_asprintf (&addr_buf, "%s --- %s, %s",
 770                    GST_plugins_a2s (plugin_name, plugin_address,
 771                                     plugin_address_len),
 772                    (GNUNET_YES ==
 773                     GST_neighbours_test_connected (target)) ? "CONNECTED" :
 774                    "DISCONNECTED",
 775                    (GNUNET_TIME_absolute_get_remaining (valid_until).rel_value >
 776                     0) ? "VALIDATED" : "UNVALIDATED");
 777   transmit_address_to_client (tc, addr_buf);
 778   GNUNET_free (addr_buf);
 779 }
 780
 781
 782 /**
 783  * Client asked to obtain information about a peer's addresses.
 784  * Process the request.
 785  * FIXME: use better name!
 786  *
 787  * @param cls unused
 788  * @param client the client
 789  * @param message the peer address information request
 790  */
 791 static void
 792 clients_handle_peer_address_lookup (void *cls,
 793                                     struct GNUNET_SERVER_Client *client,
 794                                     const struct GNUNET_MessageHeader *message)
 795 {
 796   const struct PeerAddressLookupMessage *peer_address_lookup;
 797   struct GNUNET_SERVER_TransmitContext *tc;
 798
 799   peer_address_lookup = (const struct PeerAddressLookupMessage *) message;
 800   GNUNET_break (ntohl (peer_address_lookup->reserved) == 0);
 801   tc = GNUNET_SERVER_transmit_context_create (client);
 802   GST_validation_get_addresses (&peer_address_lookup->peer,
 803                                 &send_address_to_client, tc);
 804   GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
 805                                               GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
 806   GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
 807 }
 808
 809
 810 /**
 811  * Output the active address of connected neighbours to the given client.
 812  *
 813  * @param cls the 'struct GNUNET_SERVER_TransmitContext' for transmission to the client
 814  * @param neighbour identity of the neighbour
 815  * @param ats performance data
 816  * @param ats_count number of entries in ats (excluding 0-termination)
 817  * @param transport plugin
 818  * @param addr address
 819  * @param addrlen address length
 820  */
 821 static void
 822 output_addresses (void *cls, const struct GNUNET_PeerIdentity *peer,
 823                   const struct GNUNET_TRANSPORT_ATS_Information *ats,
 824                   uint32_t ats_count,
 825                   const char * transport,
 826                   const void * addr,
 827                   size_t addrlen)
 828 {
 829   struct GNUNET_SERVER_TransmitContext *tc = cls;
 830   struct AddressIterateResponseMessage * msg;
 831   size_t size;
 832
 833   size =
 834       (sizeof (struct AddressIterateResponseMessage) + strlen(transport) + 1);
 835   msg = GNUNET_malloc (size);
 836   memcpy (&msg->peer, peer, sizeof (struct GNUNET_PeerIdentity));
 837   memcpy (&msg[0], transport, strlen(transport)+1);
 838   msg->addrlen = ntohs (addrlen);
 839   msg->pluginlen = ntohs (strlen(transport)+1);
 840
 841   transmit_binary_to_client (tc, msg, size);
 842   GNUNET_free(msg);
 843 }
 844
 845
 846 /**
 847  * Client asked to obtain information about all actively used addresses.
 848  * Process the request.  FIXME: use better name!
 849  *
 850  * @param cls unused
 851  * @param client the client
 852  * @param message the peer address information request
 853  */
 854 static void
 855 clients_handle_address_iterate (void *cls, struct GNUNET_SERVER_Client *client,
 856                                 const struct GNUNET_MessageHeader *message)
 857 {
 858   struct GNUNET_SERVER_TransmitContext *tc;
 859
 860   GNUNET_SERVER_disable_receive_done_warning (client);
 861   tc = GNUNET_SERVER_transmit_context_create (client);
 862   GST_neighbours_iterate (&output_addresses, tc);
 863   GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
 864                                               GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
 865   GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
 866 }
 867
 868
 869 /**
 870  * Start handling requests from clients.
 871  *
 872  * @param server server used to accept clients from.
 873  */
 874 void
 875 GST_clients_start (struct GNUNET_SERVER_Handle *server)
 876 {
 877   static const struct GNUNET_SERVER_MessageHandler handlers[] = {
 878     {&clients_handle_start, NULL,
 879      GNUNET_MESSAGE_TYPE_TRANSPORT_START, sizeof (struct StartMessage)},
 880     {&clients_handle_hello, NULL,
 881      GNUNET_MESSAGE_TYPE_HELLO, 0},
 882     {&clients_handle_send, NULL,
 883      GNUNET_MESSAGE_TYPE_TRANSPORT_SEND, 0},
 884     {&clients_handle_request_connect, NULL,
 885      GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT,
 886      sizeof (struct TransportRequestConnectMessage)},
 887     {&clients_handle_set_quota, NULL,
 888      GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA, sizeof (struct QuotaSetMessage)},
 889     {&clients_handle_address_lookup, NULL,
 890      GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP, 0},
 891     {&clients_handle_peer_address_lookup, NULL,
 892      GNUNET_MESSAGE_TYPE_TRANSPORT_PEER_ADDRESS_LOOKUP,
 893      sizeof (struct PeerAddressLookupMessage)},
 894     {&clients_handle_address_iterate, NULL,
 895      GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE,
 896      sizeof (struct AddressIterateMessage)},
 897     {&GST_blacklist_handle_init, NULL,
 898      GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_INIT,
 899      sizeof (struct GNUNET_MessageHeader)},
 900     {&GST_blacklist_handle_reply, NULL,
 901      GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY,
 902      sizeof (struct BlacklistMessage)},
 903     {NULL, NULL, 0, 0}
 904   };
 905   GNUNET_SERVER_add_handlers (server, handlers);
 906   GNUNET_SERVER_disconnect_notify (server, &client_disconnect_notification,
 907                                    NULL);
 908 }
 909
 910
 911 /**
 912  * Stop processing clients.
 913  */
 914 void
 915 GST_clients_stop ()
 916 {
 917   /* nothing to do */
 918 }
 919
 920
 921 /**
 922  * Broadcast the given message to all of our clients.
 923  *
 924  * @param msg message to broadcast
 925  * @param may_drop GNUNET_YES if the message can be dropped
 926  */
 927 void
 928 GST_clients_broadcast (const struct GNUNET_MessageHeader *msg, int may_drop)
 929 {
 930   struct TransportClient *tc;
 931
 932   for (tc = clients_head; tc != NULL; tc = tc->next)
 933     unicast (tc, msg, may_drop);
 934 }
 935
 936
 937 /**
 938  * Send the given message to a particular client
 939  *
 940  * @param client target of the message
 941  * @param msg message to transmit
 942  * @param may_drop GNUNET_YES if the message can be dropped
 943  */
 944 void
 945 GST_clients_unicast (struct GNUNET_SERVER_Client *client,
 946                      const struct GNUNET_MessageHeader *msg, int may_drop)
 947 {
 948   struct TransportClient *tc;
 949
 950   tc = lookup_client (client);
 951   if (NULL == tc)
 952     return;                     /* client got disconnected in the meantime, drop message */
 953   unicast (tc, msg, may_drop);
 954 }
 955
 956
 957 /* end of file gnunet-service-transport_clients.c */