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