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