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