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