2 This file is part of GNUnet.
3 (C) 2010,2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file transport/gnunet-service-transport_clients.c
23 * @brief plugin management API
24 * @author Christian Grothoff
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"
37 * How many messages can we have pending for a given client process
38 * before we start to drop incoming messages? We typically should
39 * have only one client and so this would be the primary buffer for
40 * messages, so the number should be chosen rather generously.
42 * The expectation here is that most of the time the queue is large
43 * enough so that a drop is virtually never required. Note that
44 * this value must be about as large as 'TOTAL_MSGS' in the
45 * 'test_transport_api_reliability.c', otherwise that testcase may
48 #define MAX_PENDING (128 * 1024)
52 * Linked list of messages to be transmitted to the client. Each
53 * entry is followed by the actual message.
55 struct ClientMessageQueueEntry
58 * This is a doubly-linked list.
60 struct ClientMessageQueueEntry *next;
63 * This is a doubly-linked list.
65 struct ClientMessageQueueEntry *prev;
70 * Client connected to the transport service.
72 struct TransportClient
76 * This is a doubly-linked list.
78 struct TransportClient *next;
81 * This is a doubly-linked list.
83 struct TransportClient *prev;
86 * Handle to the client.
88 struct GNUNET_SERVER_Client *client;
91 * Linked list of messages yet to be transmitted to
94 struct ClientMessageQueueEntry *message_queue_head;
97 * Tail of linked list of messages yet to be transmitted to the
100 struct ClientMessageQueueEntry *message_queue_tail;
103 * Current transmit request handle.
105 struct GNUNET_CONNECTION_TransmitHandle *th;
108 * Length of the list of messages pending for this client.
110 unsigned int message_count;
116 * Head of linked list of all clients to this service.
118 static struct TransportClient *clients_head;
121 * Tail of linked list of all clients to this service.
123 static struct TransportClient *clients_tail;
127 * Find the internal handle associated with the given client handle
129 * @param client server's client handle to look up
130 * @return internal client handle
132 static struct TransportClient *
133 lookup_client (struct GNUNET_SERVER_Client *client)
135 struct TransportClient *tc;
140 if (tc->client == client)
149 * Create the internal handle for the given server client handle
151 * @param client server's client handle to create our internal handle for
152 * @return fresh internal client handle
154 static struct TransportClient *
155 setup_client (struct GNUNET_SERVER_Client *client)
157 struct TransportClient *tc;
159 tc = GNUNET_malloc (sizeof (struct TransportClient));
161 GNUNET_CONTAINER_DLL_insert (clients_head,
169 * Function called to notify a client about the socket being ready to
170 * queue more data. "buf" will be NULL and "size" zero if the socket
171 * was closed for writing in the meantime.
174 * @param size number of bytes available in buf
175 * @param buf where the callee should write the message
176 * @return number of bytes written to buf
179 transmit_to_client_callback (void *cls,
183 struct TransportClient *tc = cls;
184 struct ClientMessageQueueEntry *q;
185 const struct GNUNET_MessageHeader *msg;
194 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
195 "Transmission to client failed, closing connection.\n");
201 while (NULL != (q = tc->message_queue_head))
203 msg = (const struct GNUNET_MessageHeader *) &q[1];
204 msize = ntohs (msg->size);
205 if (msize + tsize > size)
208 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
209 "Transmitting message of type %u to client.\n",
212 GNUNET_CONTAINER_DLL_remove (tc->message_queue_head,
213 tc->message_queue_tail,
216 memcpy (&cbuf[tsize],
224 GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
225 tc->th = GNUNET_SERVER_notify_transmit_ready (tc->client,
227 GNUNET_TIME_UNIT_FOREVER_REL,
228 &transmit_to_client_callback,
230 GNUNET_assert (tc->th != NULL);
237 * Queue the given message for transmission to the given client
239 * @param client target of the message
240 * @param msg message to transmit
241 * @param may_drop GNUNET_YES if the message can be dropped
244 unicast (struct TransportClient *tc,
245 const struct GNUNET_MessageHeader *msg,
248 struct ClientMessageQueueEntry *q;
251 if ( (tc->message_count >= MAX_PENDING) &&
252 (GNUNET_YES == may_drop) )
254 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
255 _("Dropping message of type %u and size %u, have %u/%u messages pending\n"),
260 GNUNET_STATISTICS_update (GST_stats,
261 gettext_noop ("# messages dropped due to slow client"),
266 msize = ntohs (msg->size);
267 GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
268 q = GNUNET_malloc (sizeof (struct ClientMessageQueueEntry) + msize);
269 memcpy (&q[1], msg, msize);
270 GNUNET_CONTAINER_DLL_insert_tail (tc->message_queue_head,
271 tc->message_queue_tail,
276 tc->th = GNUNET_SERVER_notify_transmit_ready (tc->client,
278 GNUNET_TIME_UNIT_FOREVER_REL,
279 &transmit_to_client_callback,
281 GNUNET_assert (tc->th != NULL);
286 * Called whenever a client is disconnected. Frees our
287 * resources associated with that client.
290 * @param client identification of the client
293 client_disconnect_notification (void *cls,
294 struct GNUNET_SERVER_Client *client)
296 struct TransportClient *tc;
297 struct ClientMessageQueueEntry *mqe;
301 tc = lookup_client (client);
305 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
306 "Client disconnected, cleaning up.\n");
308 while (NULL != (mqe = tc->message_queue_head))
310 GNUNET_CONTAINER_DLL_remove (tc->message_queue_head,
311 tc->message_queue_tail,
316 GNUNET_CONTAINER_DLL_remove (clients_head,
321 GNUNET_CONNECTION_notify_transmit_ready_cancel (tc->th);
324 GNUNET_break (0 == tc->message_count);
330 * Function called for each of our connected neighbours. Notify the
331 * client about the existing neighbour.
333 * @param cls the 'struct TransportClient' to notify
334 * @param peer identity of the neighbour
335 * @param ats performance data
336 * @param ats_count number of entries in ats (excluding 0-termination)
339 notify_client_about_neighbour (void *cls,
340 const struct GNUNET_PeerIdentity *peer,
341 const struct GNUNET_TRANSPORT_ATS_Information *ats,
344 struct TransportClient *tc = cls;
345 struct ConnectInfoMessage *cim;
348 size = sizeof (struct ConnectInfoMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information);
349 GNUNET_assert (size < GNUNET_SERVER_MAX_MESSAGE_SIZE);
350 cim = GNUNET_malloc (size);
351 cim->header.size = htons (size);
352 cim->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
353 cim->ats_count = htonl(ats_count);
357 ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
358 unicast (tc, &cim->header, GNUNET_NO);
364 * Initialize a normal client. We got a start message from this
365 * client, add him to the list of clients for broadcasting of inbound
369 * @param client the client
370 * @param message the start message that was sent
373 clients_handle_start (void *cls,
374 struct GNUNET_SERVER_Client *client,
375 const struct GNUNET_MessageHeader *message)
377 const struct StartMessage *start;
378 struct TransportClient *tc;
380 tc = lookup_client (client);
383 /* got 'start' twice from the same client, not allowed */
385 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
388 start = (const struct StartMessage*) message;
389 if ( (GNUNET_NO != ntohl (start->do_check)) &&
390 (0 != memcmp (&start->self,
392 sizeof (struct GNUNET_PeerIdentity))) )
394 /* client thinks this is a different peer, reject */
395 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
396 _("Rejecting control connection from peer `%s', which is not me!\n"),
397 GNUNET_i2s (&start->self));
398 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
401 tc = setup_client (client);
402 unicast (tc, GST_hello_get(), GNUNET_NO);
403 GST_neighbours_iterate (¬ify_client_about_neighbour, tc);
404 GNUNET_SERVER_receive_done (client, GNUNET_OK);
409 * Client sent us a HELLO. Process the request.
412 * @param client the client
413 * @param message the HELLO message
416 clients_handle_hello (void *cls,
417 struct GNUNET_SERVER_Client *client,
418 const struct GNUNET_MessageHeader *message)
420 GST_validation_handle_hello (message);
421 GNUNET_SERVER_receive_done (client, GNUNET_OK);
426 * Closure for 'handle_send_transmit_continuation'
428 struct SendTransmitContinuationContext
431 * Client that made the request.
433 struct GNUNET_SERVER_Client *client;
436 * Peer that was the target.
438 struct GNUNET_PeerIdentity target;
443 * Function called after the transmission is done. Notify the client that it is
444 * OK to send the next message.
447 * @param success GNUNET_OK on success, GNUNET_NO on failure, GNUNET_SYSERR if we're not connected
450 handle_send_transmit_continuation (void *cls,
453 struct SendTransmitContinuationContext *stcc = cls;
454 struct SendOkMessage send_ok_msg;
456 send_ok_msg.header.size = htons (sizeof (send_ok_msg));
457 send_ok_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK);
458 send_ok_msg.success = htonl (success);
459 send_ok_msg.latency = GNUNET_TIME_relative_hton (GNUNET_TIME_UNIT_FOREVER_REL);
460 send_ok_msg.peer = stcc->target;
461 GST_clients_unicast (stcc->client, &send_ok_msg.header, GNUNET_NO);
462 GNUNET_SERVER_client_drop (stcc->client);
468 * Client asked for transmission to a peer. Process the request.
471 * @param client the client
472 * @param message the send message that was sent
475 clients_handle_send (void *cls,
476 struct GNUNET_SERVER_Client *client,
477 const struct GNUNET_MessageHeader *message)
479 const struct OutboundMessage *obm;
480 const struct GNUNET_MessageHeader *obmm;
481 struct SendTransmitContinuationContext *stcc;
485 size = ntohs (message->size);
486 if (size < sizeof (struct OutboundMessage) + sizeof (struct GNUNET_MessageHeader))
489 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
492 obm = (const struct OutboundMessage *) message;
493 obmm = (const struct GNUNET_MessageHeader *) &obm[1];
494 msize = size - sizeof (struct OutboundMessage);
495 if (msize < sizeof (struct GNUNET_MessageHeader))
498 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
501 GNUNET_STATISTICS_update (GST_stats,
502 gettext_noop ("# bytes payload received for other peers"),
506 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
507 "Received `%s' request from client with target `%4s' and first message of type %u and total size %u\n",
509 GNUNET_i2s (&obm->peer),
514 GST_neighbours_test_connected (&obm->peer))
516 /* not connected, not allowed to send; can happen due to asynchronous operations */
517 GNUNET_STATISTICS_update (GST_stats,
518 gettext_noop ("# bytes payload dropped (other peer was not connected)"),
521 GNUNET_SERVER_receive_done (client, GNUNET_OK);
524 GNUNET_SERVER_receive_done (client, GNUNET_OK);
525 stcc = GNUNET_malloc (sizeof (struct SendTransmitContinuationContext));
526 stcc->target = obm->peer;
527 stcc->client = client;
528 GNUNET_SERVER_client_keep (client);
529 GST_neighbours_send (&obm->peer,
531 GNUNET_TIME_relative_ntoh (obm->timeout),
532 &handle_send_transmit_continuation,
538 * Client asked for a quota change for a particular peer. Process the request.
541 * @param client the client
542 * @param message the quota changing message
545 clients_handle_set_quota (void *cls,
546 struct GNUNET_SERVER_Client *client,
547 const struct GNUNET_MessageHeader *message)
549 const struct QuotaSetMessage *qsm;
551 qsm = (const struct QuotaSetMessage *) message;
552 GNUNET_STATISTICS_update (GST_stats,
553 gettext_noop ("# SET QUOTA messages received"),
557 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
558 "Received `%s' request (new quota %u) from client for peer `%4s'\n",
560 (unsigned int) ntohl (qsm->quota.value__),
561 GNUNET_i2s (&qsm->peer));
563 GST_neighbours_set_incoming_quota (&qsm->peer,
565 GNUNET_SERVER_receive_done (client, GNUNET_OK);
570 * Take the given address and append it to the set of results sent back to
573 * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
574 * @param address the resolved name, NULL to indicate the last response
577 transmit_address_to_client (void *cls,
580 struct GNUNET_SERVER_TransmitContext *tc = cls;
584 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
585 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
586 GNUNET_SERVER_transmit_context_run (tc,
587 GNUNET_TIME_UNIT_FOREVER_REL);
590 GNUNET_SERVER_transmit_context_append_data (tc,
591 address, strlen (address) + 1,
592 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
597 * Client asked to resolve an address. Process the request.
600 * @param client the client
601 * @param message the resolution request
604 clients_handle_address_lookup (void *cls,
605 struct GNUNET_SERVER_Client *client,
606 const struct GNUNET_MessageHeader *message)
608 const struct AddressLookupMessage *alum;
609 struct GNUNET_TRANSPORT_PluginFunctions *papi;
610 const char *plugin_name;
612 uint32_t address_len;
614 struct GNUNET_SERVER_TransmitContext *tc;
615 struct GNUNET_TIME_Relative rtimeout;
618 size = ntohs (message->size);
619 if (size < sizeof (struct AddressLookupMessage))
622 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
625 alum = (const struct AddressLookupMessage *) message;
626 address_len = ntohl (alum->addrlen);
627 if (size <= sizeof (struct AddressLookupMessage) + address_len)
630 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
633 address = (const char *) &alum[1];
634 plugin_name = (const char *) &address[address_len];
636 [size - sizeof (struct AddressLookupMessage) - address_len - 1] != '\0')
639 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
642 rtimeout = GNUNET_TIME_relative_ntoh (alum->timeout);
643 numeric = ntohl (alum->numeric_only);
644 tc = GNUNET_SERVER_transmit_context_create (client);
645 papi = GST_plugins_find (plugin_name);
648 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
649 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
650 GNUNET_SERVER_transmit_context_run (tc, rtimeout);
653 GNUNET_SERVER_disable_receive_done_warning (client);
654 papi->address_pretty_printer (papi->cls,
656 address, address_len,
659 &transmit_address_to_client, tc);
664 * Send an address to the client.
666 * @param cls our 'struct GNUNET_SERVER_TransmitContext' (for sending)
667 * @param public_key public key for the peer, never NULL
668 * @param target peer this change is about, never NULL
669 * @param valid_until until what time do we consider the address valid?
670 * @param validation_block is FOREVER if the address is for an unsupported plugin (from PEERINFO)
671 * is ZERO if the address is considered valid (no validation needed)
672 * is a time in the future if we're currently denying re-validation
673 * @param plugin_name name of the plugin
674 * @param plugin_address binary address
675 * @param plugin_address_len length of address
678 send_address_to_client (void *cls,
679 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *public_key,
680 const struct GNUNET_PeerIdentity *target,
681 struct GNUNET_TIME_Absolute valid_until,
682 struct GNUNET_TIME_Absolute validation_block,
683 const char *plugin_name,
684 const void *plugin_address,
685 size_t plugin_address_len)
687 struct GNUNET_SERVER_TransmitContext *tc = cls;
690 /* FIXME: move to a binary format!!! */
691 GNUNET_asprintf (&addr_buf, "%s --- %s, %s",
692 GST_plugins_a2s (plugin_name,
695 (GNUNET_YES == GST_neighbours_test_connected (target))
698 (GNUNET_TIME_absolute_get_remaining (valid_until).rel_value > 0)
701 transmit_address_to_client (tc, addr_buf);
702 GNUNET_free (addr_buf);
707 * Client asked to obtain information about a peer's addresses.
708 * Process the request.
709 * FIXME: use better name!
712 * @param client the client
713 * @param message the peer address information request
716 clients_handle_peer_address_lookup (void *cls,
717 struct GNUNET_SERVER_Client *client,
718 const struct GNUNET_MessageHeader *message)
720 const struct PeerAddressLookupMessage *peer_address_lookup;
721 struct GNUNET_SERVER_TransmitContext *tc;
723 peer_address_lookup = (const struct PeerAddressLookupMessage *) message;
724 GNUNET_break (ntohl (peer_address_lookup->reserved) == 0);
725 tc = GNUNET_SERVER_transmit_context_create (client);
726 GST_validation_get_addresses (&peer_address_lookup->peer,
727 &send_address_to_client,
729 GNUNET_SERVER_transmit_context_append_data (tc,
731 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
732 GNUNET_SERVER_transmit_context_run (tc,
733 GNUNET_TIME_UNIT_FOREVER_REL);
738 * Output the active address of connected neighbours to the given client.
740 * @param cls the 'struct GNUNET_SERVER_TransmitContext' for transmission to the client
741 * @param neighbour identity of the neighbour
742 * @param ats performance data
743 * @param ats_count number of entries in ats (excluding 0-termination)
746 output_addresses (void *cls,
747 const struct GNUNET_PeerIdentity *neighbour,
748 const struct GNUNET_TRANSPORT_ATS_Information *ats,
751 struct GNUNET_SERVER_TransmitContext *tc = cls;
754 /* FIXME: move to a binary format!!! */
755 GNUNET_asprintf (&addr_buf,
757 GNUNET_i2s(neighbour),
758 GST_plugins_a2s ("FIXME", NULL, 0));
759 transmit_address_to_client (tc, addr_buf);
760 GNUNET_free (addr_buf);
765 * Client asked to obtain information about all actively used addresses.
766 * Process the request. FIXME: use better name!
769 * @param client the client
770 * @param message the peer address information request
773 clients_handle_address_iterate (void *cls,
774 struct GNUNET_SERVER_Client *client,
775 const struct GNUNET_MessageHeader *message)
777 struct GNUNET_SERVER_TransmitContext *tc;
779 GNUNET_SERVER_disable_receive_done_warning (client);
780 tc = GNUNET_SERVER_transmit_context_create (client);
781 GST_neighbours_iterate (&output_addresses,
783 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
784 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
785 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
790 * Start handling requests from clients.
792 * @param server server used to accept clients from.
795 GST_clients_start (struct GNUNET_SERVER_Handle *server)
797 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
798 { &clients_handle_start, NULL, sizeof (struct StartMessage)},
799 { &clients_handle_hello, NULL, 0},
800 { &clients_handle_send, NULL, 0},
801 { &clients_handle_set_quota, NULL, sizeof (struct QuotaSetMessage)},
802 { &clients_handle_address_lookup, NULL, 0},
803 { &clients_handle_peer_address_lookup, NULL, sizeof (struct PeerAddressLookupMessage)},
804 { &clients_handle_address_iterate, NULL, sizeof (struct GNUNET_MessageHeader)},
805 { &GST_blacklist_handle_init, NULL, sizeof (struct GNUNET_MessageHeader)},
806 { &GST_blacklist_handle_reply, NULL, sizeof (struct BlacklistMessage)},
809 GNUNET_SERVER_add_handlers (server, handlers);
810 GNUNET_SERVER_disconnect_notify (server,
811 &client_disconnect_notification, NULL);
816 * Stop processing clients.
826 * Broadcast the given message to all of our clients.
828 * @param msg message to broadcast
829 * @param may_drop GNUNET_YES if the message can be dropped
832 GST_clients_broadcast (const struct GNUNET_MessageHeader *msg,
835 struct TransportClient *tc;
837 for (tc = clients_head; tc != NULL; tc = tc->next)
838 unicast (tc, msg, may_drop);
843 * Send the given message to a particular client
845 * @param client target of the message
846 * @param msg message to transmit
847 * @param may_drop GNUNET_YES if the message can be dropped
850 GST_clients_unicast (struct GNUNET_SERVER_Client *client,
851 const struct GNUNET_MessageHeader *msg,
854 struct TransportClient *tc;
856 tc = lookup_client (client);
858 tc = setup_client (client);
859 unicast (tc, msg, may_drop);
863 /* end of file gnunet-service-transport_clients.c */