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