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