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