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_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_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_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
 463   send_ok_msg.header.size = htons (sizeof (send_ok_msg));
 464   send_ok_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK);
 465   send_ok_msg.success = htonl (success);
 466   send_ok_msg.latency =
 467       GNUNET_TIME_relative_hton (GNUNET_TIME_UNIT_FOREVER_REL);
 468   send_ok_msg.peer = stcc->target;
 469   GST_clients_unicast (stcc->client, &send_ok_msg.header, GNUNET_NO);
 470   GNUNET_SERVER_client_drop (stcc->client);
 471   GNUNET_free (stcc);
 472 }
 473
 474
 475 /**
 476  * Client asked for transmission to a peer.  Process the request.
 477  *
 478  * @param cls unused
 479  * @param client the client
 480  * @param message the send message that was sent
 481  */
 482 static void
 483 clients_handle_send (void *cls, struct GNUNET_SERVER_Client *client,
 484                      const struct GNUNET_MessageHeader *message)
 485 {
 486   const struct OutboundMessage *obm;
 487   const struct GNUNET_MessageHeader *obmm;
 488   struct SendTransmitContinuationContext *stcc;
 489   uint16_t size;
 490   uint16_t msize;
 491   struct TransportClient *tc;
 492
 493   tc = lookup_client (client);
 494   if (NULL == tc)
 495   {
 496     /* client asked for transmission before 'START' */
 497     GNUNET_break (0);
 498     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 499     return;
 500   }
 501
 502   size = ntohs (message->size);
 503   if (size <
 504       sizeof (struct OutboundMessage) + sizeof (struct GNUNET_MessageHeader))
 505   {
 506     GNUNET_break (0);
 507     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 508     return;
 509   }
 510   obm = (const struct OutboundMessage *) message;
 511   obmm = (const struct GNUNET_MessageHeader *) &obm[1];
 512   msize = size - sizeof (struct OutboundMessage);
 513   if (msize < sizeof (struct GNUNET_MessageHeader))
 514   {
 515     GNUNET_break (0);
 516     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 517     return;
 518   }
 519   GNUNET_STATISTICS_update (GST_stats,
 520                             gettext_noop
 521                             ("# bytes payload received for other peers"), msize,
 522                             GNUNET_NO);
 523 #if DEBUG_TRANSPORT
 524   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 525               "Received `%s' request from client with target `%4s' and first message of type %u and total size %u\n",
 526               "SEND", GNUNET_i2s (&obm->peer), ntohs (obmm->type), msize);
 527 #endif
 528   if (GNUNET_NO == GST_neighbours_test_connected (&obm->peer))
 529   {
 530     /* not connected, not allowed to send; can happen due to asynchronous operations */
 531 #if DEBUG_TRANSPORT
 532     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 533                 "Could not send message to peer `%s': not connected\n",
 534                 GNUNET_i2s (&obm->peer));
 535 #endif
 536     GNUNET_STATISTICS_update (GST_stats,
 537                               gettext_noop
 538                               ("# bytes payload dropped (other peer was not connected)"),
 539                               msize, GNUNET_NO);
 540     GNUNET_SERVER_receive_done (client, GNUNET_OK);
 541     return;
 542   }
 543   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 544   stcc = GNUNET_malloc (sizeof (struct SendTransmitContinuationContext));
 545   stcc->target = obm->peer;
 546   stcc->client = client;
 547   GNUNET_SERVER_client_keep (client);
 548   GST_neighbours_send (&obm->peer, obmm, msize,
 549                        GNUNET_TIME_relative_ntoh (obm->timeout),
 550                        &handle_send_transmit_continuation, stcc);
 551 }
 552
 553
 554 /**
 555  * Try to initiate a connection to the given peer if the blacklist
 556  * allowed it.
 557  *
 558  * @param cls closure (unused, NULL)
 559  * @param peer identity of peer that was tested
 560  * @param result GNUNET_OK if the connection is allowed,
 561  *               GNUNET_NO if not
 562  */
 563 static void
 564 try_connect_if_allowed (void *cls, const struct GNUNET_PeerIdentity *peer,
 565                         int result)
 566 {
 567   if (GNUNET_OK != result)
 568     return;                     /* not allowed */
 569   GST_neighbours_try_connect (peer);
 570 }
 571
 572
 573 /**
 574  * Handle request connect message
 575  *
 576  * @param cls closure (always NULL)
 577  * @param client identification of the client
 578  * @param message the actual message
 579  */
 580 static void
 581 clients_handle_request_connect (void *cls, struct GNUNET_SERVER_Client *client,
 582                                 const struct GNUNET_MessageHeader *message)
 583 {
 584   const struct TransportRequestConnectMessage *trcm =
 585       (const struct TransportRequestConnectMessage *) message;
 586
 587   GNUNET_STATISTICS_update (GST_stats,
 588                             gettext_noop
 589                             ("# REQUEST CONNECT messages received"), 1,
 590                             GNUNET_NO);
 591 #if DEBUG_TRANSPORT
 592   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 593               "Received a request connect message for peer `%s'\n",
 594               GNUNET_i2s (&trcm->peer));
 595 #endif
 596   (void) GST_blacklist_test_allowed (&trcm->peer, NULL, &try_connect_if_allowed,
 597                                      NULL);
 598   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 599 }
 600
 601
 602 /**
 603  * Take the given address and append it to the set of results sent back to
 604  * the client.
 605  *
 606  * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
 607  * @param address the resolved name, NULL to indicate the last response
 608  */
 609 static void
 610 transmit_address_to_client (void *cls, const char *buf)
 611 {
 612   struct GNUNET_SERVER_TransmitContext *tc = cls;
 613
 614   if (NULL == buf)
 615   {
 616     GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
 617                                                 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
 618     GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
 619     return;
 620   }
 621   GNUNET_SERVER_transmit_context_append_data (tc, buf, strlen (buf) + 1,
 622                                               GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
 623 }
 624
 625
 626 /**
 627  * Take the given address and append it to the set of results sent back to
 628  * the client.
 629  *
 630  * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
 631  * @param address the resolved name, NULL to indicate the last response
 632  */
 633 static void
 634 transmit_binary_to_client (void *cls, void *buf, size_t size)
 635 {
 636   struct GNUNET_SERVER_TransmitContext *tc = cls;
 637
 638   if (NULL == buf)
 639   {
 640     GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
 641                                                 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
 642     GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
 643     return;
 644   }
 645   GNUNET_SERVER_transmit_context_append_data (tc, buf, size,
 646                                               GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
 647 }
 648
 649
 650 /**
 651  * Client asked to resolve an address.  Process the request.
 652  *
 653  * @param cls unused
 654  * @param client the client
 655  * @param message the resolution request
 656  */
 657 static void
 658 clients_handle_address_lookup (void *cls, struct GNUNET_SERVER_Client *client,
 659                                const struct GNUNET_MessageHeader *message)
 660 {
 661   const struct AddressLookupMessage *alum;
 662   struct GNUNET_TRANSPORT_PluginFunctions *papi;
 663   const char *plugin_name;
 664   const char *address;
 665   uint32_t address_len;
 666   uint16_t size;
 667   struct GNUNET_SERVER_TransmitContext *tc;
 668   struct GNUNET_TIME_Relative rtimeout;
 669   int32_t numeric;
 670
 671   size = ntohs (message->size);
 672   if (size < sizeof (struct AddressLookupMessage))
 673   {
 674     GNUNET_break (0);
 675     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 676     return;
 677   }
 678   alum = (const struct AddressLookupMessage *) message;
 679   address_len = ntohl (alum->addrlen);
 680   if (size <= sizeof (struct AddressLookupMessage) + address_len)
 681   {
 682     GNUNET_break (0);
 683     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 684     return;
 685   }
 686   address = (const char *) &alum[1];
 687   plugin_name = (const char *) &address[address_len];
 688   if (plugin_name[size - sizeof (struct AddressLookupMessage) - address_len - 1]
 689       != '\0')
 690   {
 691     GNUNET_break (0);
 692     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 693     return;
 694   }
 695   rtimeout = GNUNET_TIME_relative_ntoh (alum->timeout);
 696   numeric = ntohl (alum->numeric_only);
 697   tc = GNUNET_SERVER_transmit_context_create (client);
 698   papi = GST_plugins_find (plugin_name);
 699   if (NULL == papi)
 700   {
 701     GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
 702                                                 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
 703     GNUNET_SERVER_transmit_context_run (tc, rtimeout);
 704     return;
 705   }
 706   GNUNET_SERVER_disable_receive_done_warning (client);
 707   papi->address_pretty_printer (papi->cls, plugin_name, address, address_len,
 708                                 numeric, rtimeout, &transmit_address_to_client,
 709                                 tc);
 710 }
 711
 712
 713 /**
 714  * Send an address to the client.
 715  *
 716  * @param cls our 'struct GNUNET_SERVER_TransmitContext' (for sending)
 717  * @param public_key public key for the peer, never NULL
 718  * @param target peer this change is about, never NULL
 719  * @param valid_until until what time do we consider the address valid?
 720  * @param validation_block  is FOREVER if the address is for an unsupported plugin (from PEERINFO)
 721  *                          is ZERO if the address is considered valid (no validation needed)
 722  *                          is a time in the future if we're currently denying re-validation
 723  * @param plugin_name name of the plugin
 724  * @param plugin_address binary address
 725  * @param plugin_address_len length of address
 726  */
 727 static void
 728 send_address_to_client (void *cls,
 729                         const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
 730                         *public_key, const struct GNUNET_PeerIdentity *target,
 731                         struct GNUNET_TIME_Absolute valid_until,
 732                         struct GNUNET_TIME_Absolute validation_block,
 733                         const char *plugin_name, const void *plugin_address,
 734                         size_t plugin_address_len)
 735 {
 736   struct GNUNET_SERVER_TransmitContext *tc = cls;
 737   char *addr_buf;
 738
 739   /* FIXME: move to a binary format!!! */
 740   GNUNET_asprintf (&addr_buf, "%s --- %s, %s",
 741                    GST_plugins_a2s (plugin_name, plugin_address,
 742                                     plugin_address_len),
 743                    (GNUNET_YES ==
 744                     GST_neighbours_test_connected (target)) ? "CONNECTED" :
 745                    "DISCONNECTED",
 746                    (GNUNET_TIME_absolute_get_remaining (valid_until).rel_value >
 747                     0) ? "VALIDATED" : "UNVALIDATED");
 748   transmit_address_to_client (tc, addr_buf);
 749   GNUNET_free (addr_buf);
 750 }
 751
 752
 753 /**
 754  * Client asked to obtain information about a peer's addresses.
 755  * Process the request.
 756  * FIXME: use better name!
 757  *
 758  * @param cls unused
 759  * @param client the client
 760  * @param message the peer address information request
 761  */
 762 static void
 763 clients_handle_peer_address_lookup (void *cls,
 764                                     struct GNUNET_SERVER_Client *client,
 765                                     const struct GNUNET_MessageHeader *message)
 766 {
 767   const struct PeerAddressLookupMessage *peer_address_lookup;
 768   struct GNUNET_SERVER_TransmitContext *tc;
 769
 770   peer_address_lookup = (const struct PeerAddressLookupMessage *) message;
 771   GNUNET_break (ntohl (peer_address_lookup->reserved) == 0);
 772   tc = GNUNET_SERVER_transmit_context_create (client);
 773   GST_validation_get_addresses (&peer_address_lookup->peer,
 774                                 &send_address_to_client, tc);
 775   GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
 776                                               GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
 777   GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
 778 }
 779
 780
 781 /**
 782  * Output the active address of connected neighbours to the given client.
 783  *
 784  * @param cls the 'struct GNUNET_SERVER_TransmitContext' for transmission to the client
 785  * @param neighbour identity of the neighbour
 786  * @param ats performance data
 787  * @param ats_count number of entries in ats (excluding 0-termination)
 788  * @param transport plugin
 789  * @param addr address
 790  * @param addrlen address length
 791  */
 792 static void
 793 output_addresses (void *cls, const struct GNUNET_PeerIdentity *peer,
 794                   const struct GNUNET_ATS_Information *ats,
 795                   uint32_t ats_count,
 796                   const char * transport,
 797                   const void * addr,
 798                   size_t addrlen)
 799 {
 800   struct GNUNET_SERVER_TransmitContext *tc = cls;
 801   struct AddressIterateResponseMessage * msg;
 802   size_t size;
 803
 804   size =
 805       (sizeof (struct AddressIterateResponseMessage) + strlen(transport) + 1);
 806   msg = GNUNET_malloc (size);
 807   memcpy (&msg->peer, peer, sizeof (struct GNUNET_PeerIdentity));
 808   memcpy (&msg[0], transport, strlen(transport)+1);
 809   msg->addrlen = ntohs (addrlen);
 810   msg->pluginlen = ntohs (strlen(transport)+1);
 811
 812   transmit_binary_to_client (tc, msg, size);
 813   GNUNET_free(msg);
 814 }
 815
 816
 817 /**
 818  * Client asked to obtain information about all actively used addresses.
 819  * Process the request.  FIXME: use better name!
 820  *
 821  * @param cls unused
 822  * @param client the client
 823  * @param message the peer address information request
 824  */
 825 static void
 826 clients_handle_address_iterate (void *cls, struct GNUNET_SERVER_Client *client,
 827                                 const struct GNUNET_MessageHeader *message)
 828 {
 829   struct GNUNET_SERVER_TransmitContext *tc;
 830
 831   GNUNET_SERVER_disable_receive_done_warning (client);
 832   tc = GNUNET_SERVER_transmit_context_create (client);
 833   GST_neighbours_iterate (&output_addresses, tc);
 834   GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
 835                                               GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
 836   GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
 837 }
 838
 839
 840 /**
 841  * Start handling requests from clients.
 842  *
 843  * @param server server used to accept clients from.
 844  */
 845 void
 846 GST_clients_start (struct GNUNET_SERVER_Handle *server)
 847 {
 848   static const struct GNUNET_SERVER_MessageHandler handlers[] = {
 849     {&clients_handle_start, NULL,
 850      GNUNET_MESSAGE_TYPE_TRANSPORT_START, sizeof (struct StartMessage)},
 851     {&clients_handle_hello, NULL,
 852      GNUNET_MESSAGE_TYPE_HELLO, 0},
 853     {&clients_handle_send, NULL,
 854      GNUNET_MESSAGE_TYPE_TRANSPORT_SEND, 0},
 855     {&clients_handle_request_connect, NULL,
 856      GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT,
 857      sizeof (struct TransportRequestConnectMessage)},
 858     {&clients_handle_address_lookup, NULL,
 859      GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP, 0},
 860     {&clients_handle_peer_address_lookup, NULL,
 861      GNUNET_MESSAGE_TYPE_TRANSPORT_PEER_ADDRESS_LOOKUP,
 862      sizeof (struct PeerAddressLookupMessage)},
 863     {&clients_handle_address_iterate, NULL,
 864      GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE,
 865      sizeof (struct AddressIterateMessage)},
 866     {&GST_blacklist_handle_init, NULL,
 867      GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_INIT,
 868      sizeof (struct GNUNET_MessageHeader)},
 869     {&GST_blacklist_handle_reply, NULL,
 870      GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY,
 871      sizeof (struct BlacklistMessage)},
 872     {NULL, NULL, 0, 0}
 873   };
 874   GNUNET_SERVER_add_handlers (server, handlers);
 875   GNUNET_SERVER_disconnect_notify (server, &client_disconnect_notification,
 876                                    NULL);
 877 }
 878
 879
 880 /**
 881  * Stop processing clients.
 882  */
 883 void
 884 GST_clients_stop ()
 885 {
 886   /* nothing to do */
 887 }
 888
 889
 890 /**
 891  * Broadcast the given message to all of our clients.
 892  *
 893  * @param msg message to broadcast
 894  * @param may_drop GNUNET_YES if the message can be dropped
 895  */
 896 void
 897 GST_clients_broadcast (const struct GNUNET_MessageHeader *msg, int may_drop)
 898 {
 899   struct TransportClient *tc;
 900
 901   for (tc = clients_head; tc != NULL; tc = tc->next)
 902     unicast (tc, msg, may_drop);
 903 }
 904
 905
 906 /**
 907  * Send the given message to a particular client
 908  *
 909  * @param client target of the message
 910  * @param msg message to transmit
 911  * @param may_drop GNUNET_YES if the message can be dropped
 912  */
 913 void
 914 GST_clients_unicast (struct GNUNET_SERVER_Client *client,
 915                      const struct GNUNET_MessageHeader *msg, int may_drop)
 916 {
 917   struct TransportClient *tc;
 918
 919   tc = lookup_client (client);
 920   if (NULL == tc)
 921     return;                     /* client got disconnected in the meantime, drop message */
 922   unicast (tc, msg, may_drop);
 923 }
 924
 925
 926 /* end of file gnunet-service-transport_clients.c */